Swagger扩展版本控制

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
{

}

  

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章