c#

C# webapi swagger如何分组显示

小樊
88
2024-07-31 09:17:12
栏目: 编程语言

要在C# WebAPI项目中使用Swagger进行分组显示,您可以按照以下步骤操作:

  1. 安装Swashbuckle NuGet包:在Visual Studio中打开您的WebAPI项目,然后右键单击项目并选择“管理NuGet程序包”。在NuGet程序包管理器中搜索并安装Swashbuckle.AspNetCore包。

  2. 配置Swagger:在Startup.cs文件中,添加Swagger中间件和Swagger生成器的配置。例如:

services.AddSwaggerGen(c =>
{
    c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });
    c.DocInclusionPredicate((docName, apiDesc) =>
    {
        if (!apiDesc.TryGetMethodInfo(out var methodInfo)) return false;

        var versions = methodInfo.DeclaringType
                .GetCustomAttributes(true)
                .OfType<ApiVersionAttribute>()
                .SelectMany(attr => attr.Versions);

        return versions.Any(v => $"v{v.ToString()}" == docName);
    });
});
  1. 添加API版本控制:为了实现API的版本控制并在Swagger中进行分组显示,您需要使用Microsoft.AspNetCore.Mvc.Versioning包。在Startup.cs文件中配置API版本控制。例如:
services.AddApiVersioning(o =>
{
    o.ReportApiVersions = true;
    o.AssumeDefaultVersionWhenUnspecified = true;
    o.DefaultApiVersion = new ApiVersion(1, 0);
    o.ApiVersionReader = new UrlSegmentApiVersionReader();
});
  1. 分组显示:在Controller类的特性中添加ApiVersion特性来指定API版本。例如:
[ApiVersion("1.0")]
[Route("api/v{version:apiVersion}/[controller]")]
[ApiController]
public class ValuesController : ControllerBase
{
    // API methods
}

这样配置后,您的WebAPI将会根据API版本进行分组显示在Swagger UI中。您可以通过访问http://localhost:{port}/swagger/index.html来查看Swagger UI并查看分组显示效果。

0
看了该问题的人还看了