基於.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里面