如何解决按名称对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();
});
}
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。