minimal-api

SimpleModule Minimal API Endpoints

Two Endpoint Types

Interface	Purpose	Auto-applied by generator
IEndpoint	API (JSON)	.WithTags("Module") + .RequireAuthorization() on route group
IViewEndpoint	Inertia views (SSR)	.WithTags("Module") + .ExcludeFromDescription() + .RequireAuthorization() on group

Both implement void Map(IEndpointRouteBuilder app). The source generator discovers them and maps them to route groups using the module's RoutePrefix / ViewPrefix.

Endpoint File Structure

One endpoint per file (enforced by SM0049). Class name = {Action}Endpoint. Place in:

• Endpoints/{Feature}/ for IEndpoint
• Pages/ for IViewEndpoint (co-located with its .tsx component; optionally grouped in feature subfolders)

Route const (required)

Every endpoint declares a public const string Route and passes it to its MapXxx call — enforced by SM0054. Route values live in a Routes nested class on the module constants:

public class GetAllProductsEndpoint : IEndpoint
{
    public const string Route = ProductsConstants.Routes.GetAll;

    public void Map(IEndpointRouteBuilder app) =>
        app.MapGet(Route, (IProductContracts contracts) =>
            CrudEndpoints.GetAll(contracts.GetAllAsync))
        .RequirePermission(ProductsPermissions.View);
}

Parameter Binding Rules

Implicit binding (no attribute needed)

• Route params: app.MapGet("/{id}", (ProductId id, ...) => ...)
• Query params (GET): simple types bind from query string
• JSON body (POST/PUT/DELETE): complex types bind from request body
• DI services: auto-injected when registered in container
• Special types: HttpContext, ClaimsPrincipal, CancellationToken -- auto-bound

Explicit attributes required

• [FromForm] -- ALWAYS required for form data. Never implicit. Add .DisableAntiforgery() for form posts without CSRF tokens.
• [AsParameters] -- bind a class from multiple sources (route + query + header). Use for GET endpoints with multiple query filters.
• [FromQuery] -- only when name conflicts with route param
• [FromHeader(Name = "X-Header")] -- for HTTP headers
• [FromRoute] -- only when disambiguation needed