按名称对OpenAPI / Swagger中的排序方法

问题描述

我想对Swagger索引进行API方法的排序，并根据Get，Post，Put和Delete将它们分组。如How to sort methods by path?所述，这些方法在我的页面上排序。由于该页面上的解决方法太旧，我正在寻找一种可以用于最新方法的解决方案。是否可以通过在Startup.cs等上进行配置更改来订购ASP.NET Core应用中的API方法？

解决方法

首先，安装软件包Swashbuckle.AspNetCore：

Install-Package Swashbuckle.AspNetCore -Version 5.5.0

然后您可以按以下方式进行配置：

services.AddSwaggerGen(c =>
{
    c.OrderActionsBy((apiDesc) => $"{apiDesc.ActionDescriptor.RouteValues["controller"]}_{apiDesc.RelativePath}");
    //...
});

结果：

更新：

如果不包含控制器，只需使用：

public void ConfigureServices(IServiceCollection services)
{
    services.AddControllers();
    services.AddSwaggerGen(c =>
    {
        c.OrderActionsBy((apiDesc) => $"{apiDesc.RelativePath}");  //change here...
    });
}

public void Configure(IApplicationBuilder app,IWebHostEnvironment env)
{
    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
    }
    app.UseHttpsRedirection();
    app.UseSwagger();
      
    app.UseSwaggerUI(c =>
    {
        c.SwaggerEndpoint("/swagger/v1/swagger.json","API Test Version 1");
    });
    app.UseRouting();

    app.UseAuthorization();

    app.UseEndpoints(endpoints =>
    {
        endpoints.MapControllers();
    });
}