AugusteVN.Modules.Sponsorships.Api 1.0.7

AugusteVN.Modules.Sponsorships.Api

Minimal API endpoints for sponsor segment management — with scoped-permission authorization, FluentValidation, and CQRS dispatch via Mapster.

Part of the AugusteVN Modules collection.

Extension Methods

AddSponsorshipsApi(this IServiceCollection, IConfiguration)

Registers the Sponsorships API layer:

• Scans the _Shared assembly for FluentValidation validators (CreateSponsorSegmentRequest and related) and registers them in the DI container.

MapSponsorshipsEndpoints(this IEndpointRouteBuilder)

Maps all sponsor segment endpoints under a single route group (SponsorSegments) with:

• Tagged Swagger grouping (SponsorSegments)
• ApiExceptionFilter for centralized exception-to-ProblemDetails mapping
• Individual endpoint registration via extension methods

API Routes

All routes are grouped under /SponsorSegments.

GET /SponsorSegments/

Retrieves paginated sponsor segments. Accepts PageNumber and PageSize query parameters via GetSponsorSegmentsRequest. Requires ManageSponsorships permission.

GET /SponsorSegments/{Id}

Retrieves a single sponsor segment by its unique Guid identifier. Requires ManageSponsorships permission.

GET /SponsorSegments/Content

Retrieves the sponsor segment associated with a specific blog post via BlogPostSlug query parameter. This endpoint is publicly accessible (no authorization) so content pages can embed sponsor segments.

POST /SponsorSegments/

Creates a new sponsor segment. The request body is validated through EndpointValidationFilter<CreateSponsorSegmentRequest>. Returns 204 No Content on success.

PUT /SponsorSegments/

Updates an existing sponsor segment. Requires ManageSponsorships permission. The request body is validated through EndpointValidationFilter<UpdateSponsorSegmentRequest>. Returns 204 No Content on success.

Authorization

Endpoints use the RequirePermission extension method on the route builder chain:

builder.MapGet("/", GetSponsorSegmentsAsync)
    .RequirePermission(nameof(Sponsorships), (int)Permissions.ManageSponsorships);

The GetSponsorSegmentsForContent endpoint is intentionally left without authorization to allow anonymous content rendering.

Error Handling

All endpoints use ApiExceptionFilter (extending EndpointExceptionFilter) to convert exceptions into RFC 7807 Problem Details responses. CQRS results use the Result pattern — failures are mapped to Results.Problem(result.Error.Description).

Registration

// Program.cs
builder.Services.AddSponsorshipsApi(builder.Configuration);

app.MapSponsorshipsEndpoints();

Installation

dotnet add package AugusteVN.Modules.Sponsorships.Api

Full Documentation

See the Sponsorships Module README for complete documentation.