本次所用版本为 .Net6.0
现象:在Swagger启动后,API接口等不显示注释描述,如下:
在代码中找到调用AddSwaggerGen的地方,如下:
builder.Services.AddSwaggerGen();
修改为:
builder.Services.AddSwaggerGen(c =>
{var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);c.IncludeXmlComments(xmlPath, true);
});
在项目右键-》选择属性-》生成-》输出-》勾选 生成包含API文档的文件,如下所示:
以上两步完成后就可以显示注释描述了。