TiqriGlobalShop.Common.AspNetCore 1.0.0

GlobalShop.Common.AspNetCore

Shared ASP.NET Core infrastructure for GlobalShop web APIs.

Features

• Exception Handlers — Production-ready IExceptionHandler implementations:

  • CancellationExceptionHandler — Handles client-cancelled requests (HTTP 499)
  • ConcurrencyExceptionHandler — Handles EF Core optimistic concurrency conflicts (HTTP 409)
  • PostgresExceptionHandler — Maps PostgreSQL error codes to appropriate HTTP responses
  • DatabaseExceptionHandler — Handles general database connectivity errors (HTTP 503)
  • GlobalExceptionHandler — Catch-all for unhandled exceptions (HTTP 500), with dev-mode details

• Middleware

  • RequestContextLoggingMiddleware — Extracts/generates X-Correlation-Id and pushes it into the Serilog LogContext

• Minimal API Endpoints

  • IEndpoint — Interface for discoverable minimal API endpoints
  • EndpointExtensions — Auto-discovers and maps IEndpoint implementations from an assembly

• Swagger / OpenAPI

  • SwaggerDefaultValues — Populates default API version parameters, deprecation markers, and response content types
  • ApiVersionHeaderOperationFilter — Adds x-api-version header parameter to all Swagger operations
  • ServiceCollectionExtensions.AddSwaggerGenWithJwtAuth() — Configures Swagger with JWT Bearer authentication, custom schema IDs, and operation filters
  • ApplicationBuilderExtensions.UseSwaggerWithUi() — Enables Swagger + Swagger UI middleware

• Result Pattern Helpers

  • ResultExtensions.Match() — Pattern-match on Result / Result<T> for railway-oriented endpoint handlers
  • CustomResults.Problem() — Converts Result failures to RFC 9457 Problem Details responses

• JSON Patch

  • JsonPatchBinder<TModel> — Base class for model-binding JsonPatchDocument<T>

Installation

dotnet add package GlobalShop.Common.AspNetCore

Quick Start

Register Exception Handlers

// In Program.cs or ConfigureServices
builder.Services.AddProblemDetails();
builder.Services.AddCommonExceptionHandlers(); // registers all 5 handlers

// ...
app.UseExceptionHandler();

Or register individual handlers:

builder.Services.AddExceptionHandler<CancellationExceptionHandler>();
builder.Services.AddExceptionHandler<GlobalExceptionHandler>();

Use Correlation ID Middleware

app.UseRequestContextLogging(); // adds X-Correlation-Id to Serilog LogContext
app.UseSerilogRequestLogging();

Discover Minimal API Endpoints

// Register
builder.Services.AddEndpoints(Assembly.GetExecutingAssembly());

// Map
app.MapEndpoints();

Implement endpoints:

public sealed class GetProducts : IEndpoint
{
    public void MapEndpoint(IEndpointRouteBuilder app)
    {
        app.MapGet("/products", Handle);
    }

    private static async Task<IResult> Handle(/* dependencies */) { /* ... */ }
}

Swagger with JWT Auth

// In Program.cs — register your app-specific Swagger docs
builder.Services.AddTransient<IConfigureOptions<SwaggerGenOptions>, ConfigureSwaggerOptions>();

// Register generic JWT auth + operation filters
builder.Services.AddSwaggerGenWithJwtAuth();

Result Pattern Helpers

using GlobalShop.Common.AspNetCore.Extensions;
using GlobalShop.Common.AspNetCore.Results;

// In a minimal API endpoint handler
return result.Match(Results.Ok, CustomResults.Problem);

Swagger Filters

builder.Services.AddSwaggerGen(o =>
{
    o.OperationFilter<SwaggerDefaultValues>();
    o.OperationFilter<ApiVersionHeaderOperationFilter>();
});

Dependencies

License

MIT