.Net6 之 asp.net core webapi Swagger 版本控制及接口注释说明

只有一个版本的webapi 配置如下

第一步首先在控制器上和每个接口方法上添加注释如图

第二步：打开项目的.csproj文件加上添加

如图：

第三步：在 Program.cs配置文件中添加如下代码：

builder.Services.AddSwaggerGen(options =>
{
    options.SwaggerDoc("v1", new OpenApiInfo
    {
        Version = "v1",
        Title = "API标题",
        Description = $"API描述,v1版本"
    });
    var xmlFilename = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
    //IncludeXmlComments 第二参数 true 则显示 控制器 注释
    options.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, xmlFilename), true);
});

效果如下图

多个版本的webapi 配置如下：

第一步：先自定义一个类：笔者为：ApiVersionInfo.cs 代码如下：

namespace WebApplication2
{
    /// <summary>
    /// api版本号
    /// </summary>
    public  class ApiVersionInfo
    {
        public static string 接口版本V1;
        public static string 接口版本V2;
        public static string 接口版本V3;
        public static string 接口版本V4;
        public static string 接口版本V5;
    }
}

第二步：规定控制属于哪个版本。在控制器上添加代码：

[ApiExplorerSettings(GroupName =nameof(ApiVersionInfo.接口版本V1))]

如图：

第三步：在 Program.cs配置文件中添加如下代码：

builder.Services.AddSwaggerGen(options =>
{
    foreach (FieldInfo fileld in typeof(ApiVersionInfo).GetFields())
    {
        options.SwaggerDoc(fileld.Name, new OpenApiInfo
        {
            Version = fileld.Name,
            Title = "API标题",
            Description = $"API描述,{fileld.Name}版本"
        });

    }
    var xmlFilename = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
    //IncludeXmlComments 第二参数 true 则显示 控制器 注释
    options.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, xmlFilename),true);
});


省略的代码。。。。。。。。。


if (app.Environment.IsDevelopment())
{
    app.UseSwagger();
    app.UseSwaggerUI(c =>
    {
        foreach (FieldInfo field in typeof(ApiVersionInfo).GetFields())
        {
            c.SwaggerEndpoint($"/swagger/{field.Name}/swagger.json", $"{field.Name}");
        }
    });
}

效果如下图：

上图是 v1版本下的接口，如果需要 v2中有接口数据，需要返回第二步在其他控制器上定义

[ApiExplorerSettings(GroupName =nameof(ApiVersionInfo.接口版本V2))]

.Net6 之 asp.net core webapi Swagger 版本控制及接口注释说明

猜你喜欢