Минимальный API в .NET 6 с использованием нескольких файлов

Question

В Net 6 можно создавать минимальные API:

      var builder = WebApplication.CreateBuilder(args);
var app = builder.Build();

app.MapGet("/products/{id}", (int id) => { return Results.Ok(); })
app.MapGet("/users/{id}", (int id) => { return Results.Ok(); })

app.Run();

Каков был бы подход к группировке конечных точек в нескольких файлах вместо того, чтобы все они были в файле программы?

      ProductEndpoints.cs:

app.MapGet("/products/{id}", (int id) => { return Results.Ok(); })

UserEndpoints.cs

app.MapGet("/users/{id}", (int id) => { return Results.Ok(); })

Answer 1

Для каждого проекта допускается только один файл с оператором верхнего уровня . Но никто не запрещает перемещать конечные точки на какой-то статический метод другого класса:

      public static class ProductEndpointsExt
{
    public static void MapProductEndpoints(this WebApplication app)
    {
        app.MapGet("/products/{id}", (int id) => { return Results.Ok(); });
    }
}

И в Programфайл:

      app.MapProductEndpoints();

Answer 2

Мы также можем использовать частичные файлы Program.cs.

Пример: «Программа.Пользователи.cs»

      partial class Program
{
    /// <summary>
    /// Map all users routes
    /// </summary>
    /// <param name="app"></param>
    private static void AddUsers(WebApplication app)
    {
        app.MapGet("/users", () => "All users");
        app.MapGet("/user/{id?}", (int? id) => $"A users {id}");
        ///post, patch, delete...
    }
}

И в "Program.cs"

      ...
var app = builder.Build();

// Configure the HTTP request pipeline.
if (app.Environment.IsDevelopment())
{
    app.UseSwagger();
    app.UseSwaggerUI();
}
//add...
AddUsers(app);
...

Answer 3

Что я сделал, так это создал интерфейс IEndPoint, который должен реализовать каждый класс, которому необходимо определить конечные точки, и метод расширения для поиска всех реализаций для вызова метода отображения интерфейса. Вам просто нужно вызвать этот метод расширения в Program.cs или Startup, чтобы зарегистрировать все конечные точки.

      // IEndpoint.cs
public interface IEndPoint
{
    void MapEndpoint(WebApplication app);
}

      // FeatureA.cs
public class FeatureA: IEndPoint
{
    public void MapEndpoint(WebApplication app)
    {
        app.MapGet("api/FeatureA/{id}", async (int id) => $"Fetching {id} data");
    }
}

      // WebApplicationExtension.cs
public static class WebApplicationExtensions
{
    public static void MapEndpoint(this WebApplication app)
    {
        var assemblies = AppDomain.CurrentDomain.GetAssemblies();
            
        var classes = assemblies.Distinct().SelectMany(x => x.GetTypes())
            .Where(x => typeof(IEndPoint).IsAssignableFrom(x) && !x.IsInterface && !x.IsAbstract);

        foreach (var classe in classes)
        {
            var instance = Activator.CreateInstance(classe) as IEndPoint;
            instance?.MapEndpoint(app);
        }
    }
}

      // Program.cs
...
app.MapEndpoint();
...

Answer 4

Обновлять

С.Net7. Теперь у вас есть возможность MapGroup.

Пример:

       public static class GroupEndpointsExt
 {
     public static RouteGroupBuilder MapTodosApi(this RouteGroupBuilder group)
     {
         group.MapGet("/", GetAllTodos);
         group.MapGet("/{id}", GetTodo);
         group.MapPost("/", CreateTodo);
         group.MapPut("/{id}", UpdateTodo);
         group.MapDelete("/{id}", DeleteTodo);

         return group;
     }
 }

ТвойProgram.cs.

      var root = app.MapGroup("minimalapi");
root.MapTodosApi();

Answer 5

Ну, вы можете иметь частичный класс Program:

      partial class Program
{
    static void MapProductEndpoints(WebApplication app)
    {
        app.MapGet("/products/{id}", (int id) => Results.Ok());
    }
}

var app = builder.Build();
MapProductEndpoints(app);

или вы можете иметь статический класс или метод расширения:

      public static class ProductEndpoints
{
    public static void Map(WebApplication app)
    {
        app.MapGet("/products/{id}", (int id) => Results.Ok());
    }
}

var app = builder.Build();
ProductEndpoints.Map(app);

      public static class WebApplicationProductEndpointsExtensions
{
    public static void MapProductEndpoints(this WebApplication app)
    {
        app.MapGet("/products/{id}", (int id) => Results.Ok());
    }
}

var app = builder.Build();
app.MapProductEndpoints();

или вы можете обернуть его в интерфейс и выполнить сканирование сборки:

      public interface IEndpoints
{
    static abstract void Map(WebApplication app);
}

public class ProductEndpoints : IEndpoints
{
    public static void Map(WebApplication app)
    {
        app.MapGet("/products/{id}", (int id) => Results.Ok());
    }
}

var app = builder.Build();

var assembly = Assembly.GetExecutingAssembly();

var endpointsCollection = assembly
    .GetTypes()
    .Where(t => t.GetInterfaces().Contains(typeof(IEndpoints)) && !t.IsInterface);

foreach (var endpoints in endpointsCollection)
{
    var map = endpoints.GetMethod(nameof(IEndpoints.Map));
    map.Invoke(null, new[] { app });
}

Вы также можете попытаться создать конечную точку для каждого файла, хотя это сложнее обеспечить.

Answer 6

Другой вариант - использовать проект Carter.

1. Добавить проект картера в Nugetdotnet add package carter

2. Измените Program.cs, чтобы использовать carter

      var builder = WebApplication.CreateBuilder(args);
builder.Services.AddCarter();

var app = builder.Build();

app.MapCarter();
app.Run();

Обратите внимание, что .AddControllers() можно удалить.

3. Добавьте модуль Carter, позже он будет обнаружен автоматически.

      using Carter;
using MapEndpoints;

public class WeatherModule : ICarterModule
{
    private static readonly string[] Summaries = new[]
    {
        "Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching"
    };

    public void AddRoutes(IEndpointRouteBuilder app)
    {
        app.MapGet("/GetWeatherForecast", (ILoggerFactory loggerFactory) => Enumerable.Range(1, 5).Select(index =>
                new WeatherForecast
                {
                    Date = DateTime.Now.AddDays(index),
                    TemperatureC = Random.Shared.Next(-20, 55),
                    Summary = Summaries[Random.Shared.Next(Summaries.Length)]
                })
            .ToArray());
    }
}

public class WeatherForecast
{
    public DateTime Date { get; set; }

    public int TemperatureC { get; set; }

    public int TemperatureF => 32 + (int)(TemperatureC / 0.5556);

    public string? Summary { get; set; }
}

Answer 7

Я думаю, что лучший способ - использовать веб-сервис на основе контроллера. Хотя вы можете использовать этот подход следующим образом:

      var builder = WebApplication.CreateBuilder(args);

builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();

var app = builder.Build();

if (app.Environment.IsDevelopment())
{
    app.UseSwagger();
    app.UseSwaggerUI();
}

app.UseHttpsRedirection();

app.MapWeatherForecastRoutes();

app.Run();

internal static class WeatherForecastController
{
    internal static void MapWeatherForecastRoutes(this WebApplication app)
    {
        app.MapGet("/weatherforecast", () =>
            {
                var summaries = new[]
                {
                        "Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching"
                };

                var forecast = Enumerable.Range(1, 5).Select(index =>
                        new WeatherForecast
                        (
                            DateOnly.FromDateTime(DateTime.Now.AddDays(index)),
                            Random.Shared.Next(-20, 55),
                            summaries[Random.Shared.Next(summaries.Length)]
                        ))
                    .ToArray();
                return forecast;
            })
            .WithName("GetWeatherForecast")
            .WithOpenApi();
    }
}

internal record WeatherForecast(DateOnly Date, int TemperatureC, string? Summary)
{
    public int TemperatureF => 32 + (int)(TemperatureC / 0.5556);
}

Единственное, что нам нужно рассмотреть, это как наилучшим образом использовать методы расширения. Достаточно реализовать каждую группу веб-сервисов в статическом классе и добавить их в программу с помощью методов Extension.