Swagger扩展版本控制

最新推荐文章于 2025-02-18 15:24:58 发布

算盘

最新推荐文章于 2025-02-18 15:24:58 发布

阅读量253

点赞数

文章标签： asp.net Swagger

本文链接：https://blog.youkuaiyun.com/codinglab/article/details/131837171

版权

文章介绍了如何在程序中创建ApiVersions枚举来定义版本，并在Program.cs文件中配置SwaggerGen以支持多个版本的API文档。同时，展示了如何在控制器上添加版本控制特性，以便在开发环境中使用SwaggerUI展示不同版本的API。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

1、在程序里面建立一个ApiVersions.cs文件，用来设置版本

public enum ApiVersions
{
    /// <summary>
    /// 版本一
    /// </summary>
    V1,

    /// <summary>
    /// 版本二
    /// </summary>
    V2,

    /// <summary>
    /// 版本三
    /// </summary>
    V3
}

2、在Program.cs文件里面修改相应的内容
将AddSwaggerGen修改为以下内容

builder.Services.AddSwaggerGen(option =>
{
    //要启用swagger版本控制要在app控制器或者方法上添加特性[ApiExplorerSettings(GropuName="版本号")]
    typeof(ApiVersions).GetEnumNames().ToList().ForEach(version =>
    {
        option.SwaggerDoc(version, new OpenApiInfo()
        {
            Title = $"{version}:Api文档",
            Version = version,
            Description = $"通用版本的CoreApi版本{version}"
        });
    });
});

对app.UseSwaggerUI修改成以下内容

if (app.Environment.IsDevelopment())
{
    app.UseSwagger();
    app.UseSwaggerUI(option =>
    {
        foreach(string version in typeof(ApiVersions).GetEnumNames())
        {
            option.SwaggerEndpoint($"/swagger/{version}/swagger.json", $"API版本：{version}");
        }
    });
}

3、在控制器文件里面添加版本控制

[ApiExplorerSettings(IgnoreApi = false, GroupName = nameof(ApiVersions.V1))]
public class CompanyController : ControllerBase
{

}