Saturna.DorApiExplorer 1.1.1

<p align="center"> <img src="icon.png" alt="DorApiExplorer" width="160" /> <h1 align="center">DorApiExplorer</h1> </p>

<p align="center"> Automate API endpoints registration.<br> <b>DorApiExplorer</b> provides a source-generated endpoints registration for minimal API in ASP NET Core. </p>

Features

• NET 6 / 8 / 10 support
• Automatic endpoints registration

Getting Started

Install the package via NuGet :

dotnet add package Saturna.DorApiExplorer

Or using the Package Manager :

Install-Package Saturna.DorApiExplorer

Usage

DorApiExplorer allows you to automatically register your endpoints while splitting them in separated files.

Start by adding the generated extension method to your DI container and the mapping extension method to your app :

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.
// Learn more about configuring OpenAPI at https://aka.ms/aspnet/openapi
builder.Services
    .AddDorApiExplorer();  // <-- here

var app = builder.Build();

app.MapEndpoints();  // <-- here

Create your endpoint, here for the exemple we will keep it as light as possible :

using DorApiExplorer;

public sealed class WeatherForecastEndpoint
    : IEndpoint
{
    private static readonly ReadOnlyMemory<string> Summaries = new[]
    {
        "Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching"
    };

    public void MapEndpoint(IEndpointRouteBuilder app)
    {
        app.MapGet("/weatherforecast/{amount:int}", (int amount)
        {
            foreach (var element in Enumerable.Range(1, amount).Select(index =>
                     new WeatherForecast
                     (
                         DateOnly.FromDateTime(DateTime.Now.AddDays(index)),
                         Random.Shared.Next(-20, 55),
                         Summaries.Span[Random.Shared.Next(Summaries.Length)]
                     )))
            {
                return element;
            }
        }).WithName("GetWeatherForecast");
    }
}

It also offers a way to create MapGroup, to achieve this you can use the EndpointPrefixAttribute on your class or on a parent one.

using DorApiExplorer;

[EndpointPrefix("/api")]
public abstract class ApiEndpoints : IEndpoint
{
    public abstract void MapEndpoint(IEndpointRouteBuilder app);
}

[EndpointPrefix("/weatherforecast")]
public sealed class WeatherForecastEndpoint
    : ApiEndpoints
{
    public override void MapEndpoint(IEndpointRouteBuilder app)
    {
        app.MapGet("/{amount:int}", async (IMediator mediator, int amount) => await mediator.Send(new WeatherForecastQuery(amount)))
            .WithName("GetWeatherForecast");
    }
}

This will create a route like this : /api/weatherforecast/{amount:int}.

NB : This attribute is optional.

And that's it !

License

This project is licensed under the MIT License - see the LICENSE file for details.