使用多个文件在.NET 6中实现最小API

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();

如何将多个端点分组到不同的文件中，而不是都放在Program文件中？

ProductEndpoints.cs:

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

UserEndpoints.cs

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

- Miguel Moura

Answer 1

每个项目只允许有一个具有顶级语句的文件，但没有人禁止将端点移到另一个类的某个静态方法中：

每个项目只允许有一个具有顶级语句的文件 per project。 但没有人禁止将端点移动到另一个类的某个静态方法中：

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

在 Program 文件中：

app.MapProductEndpoints();

- Guru Stron

Answer 2

我们也可以使用部分 Program.cs 文件。

例如："Program.Users.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);
...

- haiduong87

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();
...

- Jean-Francois Rondeau

---

我非常喜欢这种方法，谢谢！ - Jeremiah Cooper

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();

- Denis Micheal

Answer 5

另一个选项是使用Carter项目

1. 将Carter项目添加到Nuget dotnet 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; }
}

- Lonli-Lokli

---

RouteGroupBuilder怎么样？app.MapGroup如何在ICarterModule中实现？ - Vadim Tomashevsky

我不知道为什么这个被踩了。它回答了问题。我看到的所有解决方案都使用了不允许从构造函数或属性进行依赖注入的静态方法。这意味着你必须使用服务定位器。Carter允许你像MapGroup一样分组你的端点，并且允许你使用依赖注入，但不使用静态类和方法。 - DerHaifisch

@DerHaifisch，实际上并不是这样的 - 它将模块注册为单例，因此您无法在模块的构造函数中每个HTTP请求注入新的DbContext实例。 - mariusz96

@mariusz96 我忘记了你可以通过路由函数传递依赖项这个事实，因此由于这个疏忽，我一直以为获取依赖项的唯一方法是通过服务定位。 - DerHaifisch

@DerHaifisch 很高兴你有这样的感受 :) 尽管最佳实践的用法可能有些违反直觉，但我个人并不反对Carter的使用： https://github.com/CarterCommunity/Carter/issues/279 https://github.com/CarterCommunity/Carter/issues/288. - undefined

Answer 6

嗯，你可以有一个部分的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 });
}

你也可以尝试每个文件设置一个端点，不过这样更难强制执行。

- mariusz96

Answer 7

我认为最好的方法是使用基于控制器的Web服务。虽然，你可以像这样使用这种方法：

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);
}

我们需要考虑的唯一问题就是如何最好地利用扩展方法。 只需在静态类中实现每组 Web 服务并使用扩展方法将它们添加到程序中即可。

- Mohammad Sadeq Sirjani