MinimalApiBuilder 4.0.0

MinimalApiBuilder

Reflectionless, source-generated, thin abstraction layer over the ASP.NET Core Minimal APIs interface.

How to Use

Based on the Vertical Slice Architecture with Feature folder. There is one class for every API endpoint. A basic example looks like the following:

using Microsoft.AspNetCore.Mvc;
using MinimalApiBuilder;

public partial class BasicEndpoint : MinimalApiBuilderEndpoint
{
    private static string Handle([FromServices] BasicEndpoint endpoint)
    {
        return "Hello, World!";
    }
}

The endpoint class must be partial, inherit from MinimalApiBuilderEndpoint, and have a static Handle or HandleAsync method with the containing type passed from dependency injection. The endpoint is mapped through the typical IEndpointRouteBuilder Map<Verb> extension methods:

app.MapGet<BasicEndpoint>("/hello");

The above is functionally equivalent to:

app.MapGet("/hello", static () => "Hello, World!");

This library depends on FluentValidation >= 11. An endpoint can have a validated request object:

public struct BasicRequest
{
    public required string Name { get; init; }
}

public partial class BasicRequestEndpoint : MinimalApiBuilderEndpoint
{
    private static string Handle([FromServices] BasicRequestEndpoint endpoint,
        [AsParameters] BasicRequest request)
    {
        return $"Hello, {request.Name}!";
    }
}

public class BasicRequestValidator : AbstractValidator<BasicRequest>
{
    public BasicRequestValidator()
    {
        RuleFor(static request => request.Name).MinimumLength(2);
    }
}

app.MapGet<BasicRequestEndpoint>("/hello/{name}");

The incremental generator will generate code to validate the request object before the handler is called and return a 400 Bad Request response if the validation fails. In Program.cs the below

builder.Services.AddMinimalApiBuilderEndpoints();

needs to be added to register the necessary types with dependency injection.

Configuration

Users can add configuration through entries in .editorconfig or with MSBuild properties. The following options are available:

minimalapibuilder_assign_name_to_endpoint (true | false)

If true, the generator will add a unique public const string Name field to the endpoint classes and call the WithName extension method when mapping them.

minimalapibuilder_assign_name_to_endpoint = true

<PropertyGroup>
  <minimalapibuilder_assign_name_to_endpoint>true</minimalapibuilder_assign_name_to_endpoint>
</PropertyGroup>