基于.Net6.0開發(fā)WebApi(二) —— Swagger的配置
Swagger基本配置
- 項目-》右鍵屬性-》生成=》輸出=》文檔文件=》生成包含API文檔的文件【前面打上勾,文件默認(rèn)生成在運(yùn)行目錄下】
- 特別注意:整個項目都會出現(xiàn)【CS1591:缺少對公共可見類型或成員“XXX”的XML注釋】,只需要在【項目-》右鍵屬性-》生成-》錯誤和警告-》取消顯示警告】中添加【1591】保存后即可
builder.Services.AddSwaggerGen(options => { options.SwaggerDoc("v1", new OpenApiInfo { Version = "v1", Title = "Api標(biāo)題", Description = "Api描述" }); //顯示注釋 var xmlFileName = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml"; options.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, xmlFileName)); });
Swagger設(shè)置參數(shù)(折疊、不顯示Models【Schemas】)

c.DocExpansion(DocExpansion.None);//DocExpansion設(shè)置為None可折疊所有方法 c.DefaultModelExpandDepth(-1);//-1 可不顯示Models
Swagger控制器的注釋和排序
WebApi項目下新建【Swagger】文件夾,新建【AuthTagDescriptions】并繼承【IDocumentFilter】

Program類注入

Swagger版本控制,待定
可以參加Net5.0里面

浙公網(wǎng)安備 33010602011771號