.NET 6让Swagger显示注释

在使用ASP.NET CORE开发webapi时,希望在每个方法后面添加介绍,以便于我们测试和前端的阅读。

首先打开你项目的.csproj文件,打开方式 右键项目 -> 编辑项目文件:

<PropertyGroup>
    //加上底下这行代码
    <GenerateDocumentationFile>True</GenerateDocumentationFile>
</PropertyGroup> 

.或者 右键项目 -> 属性 -> 生成 -> 输出 -> 文档文件 -> 勾选上生成包含API文档的文件。

然后Progarm.cs 添加如下代码:

builder.Services.AddSwaggerGen(options => {
    //注释
    var xmlFilename = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
    //第二个参数为是否显示控制器注释,我们选择true
    options.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, xmlFilename),true);
});