基于.Net6.0开发WebApi（二） —— Swagger的配置

Swagger基本配置

• 项目-》右键属性-》生成=》输出=》文档文件=》生成包含API文档的文件【前面打上勾，文件默认生成在运行目录下】
  • 特别注意：整个项目都会出现【CS1591：缺少对公共可见类型或成员“XXX”的XML注释】，只需要在【项目-》右键属性-》生成-》错误和警告-》取消显示警告】中添加【1591】保存后即可

builder.Services.AddSwaggerGen(options =>
{
    options.SwaggerDoc("v1", new OpenApiInfo
    {
        Version = "v1",
        Title = "Api标题",
        Description = "Api描述"
    });
    //显示注释
    var xmlFileName = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
    options.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, xmlFileName));
});

Swagger设置参数（折叠、不显示Models【Schemas】）

c.DocExpansion(DocExpansion.None);//DocExpansion设置为None可折叠所有方法
c.DefaultModelExpandDepth(-1);//-1 可不显示Models

Swagger控制器的注释和排序

WebApi项目下新建【Swagger】文件夹，新建【AuthTagDescriptions】并继承【IDocumentFilter】

Program类注入

Swagger版本控制，待定

可以参加Net5.0里面