.netcore 3.1中使用swagger显示注释

.netcore 3.1中使用swagger显示注释

解决方案

 

一、勾选xml文档文件

项目--> 右键属性--> 生成-->勾选xml文档文件，系统会默认生成一个文件，并拷贝最后的名称.xml

 

二、 Startup.cs文件配置参数

添加代码截图

 

 添加代码如下

var basePath = AppContext.BaseDirectory;
//配置swagger注释
var xmlPath = Path.Combine(basePath, "WebCoreAPI.xml");
//把接口文档的路径配置进去。第二个参数表示是否开启包含对Controller的注释容纳
c.IncludeXmlComments(xmlPath, true); //默认的第二个参数是false，修为true

或者

var xmlPath = Path.Combine(Microsoft.DotNet.PlatformAbstractions.ApplicationEnvironment.ApplicationBasePath,
 "WebCoreAPI.xml");// 配置接口文档文件路径
c.IncludeXmlComments(xmlPath, true);

 

三、注释正常显示