开发随笔记录——关于Swagger调试时API接口注释显示问题处理。

声明:博主在使用Swagger时踩了许多的坑,因此记录下来与各大网友们进行分享,并以此共勉。

首先基于Swagger已经安装完毕的基础上(若还未安装可以参考博主上一篇文章),在Startup.cs文件中ConfigureServices方法,在里面找到services.AddSwaggerGen方法,在其中添加如下代码:

// 为 Swagger JSON and UI设置xml文档注释路径
var basePath = Path.GetDirectoryName(typeof(Program).Assembly.Location);//获取应用程序所在目录(绝对,不受工作目录影响,建议采用此方法获取路径)
var xmlPath = Path.Combine(basePath, "PracticeDemo.Api.xml");
// 添加控制器层注释,true表示显示控制器注释 false表示只显示API接口的注释
c.IncludeXmlComments(xmlPath,true);

之后在进行XML文件配置。操作顺序:项目右键,选择属性,勾选“XML文档文件”,如下图所示:

开发随笔记录——关于Swagger调试时API接口注释显示问题处理。

之后在控制器中添加各个API、以及控制器的注释即可。如图所示:

开发随笔记录——关于Swagger调试时API接口注释显示问题处理。

效果如图:

开发随笔记录——关于Swagger调试时API接口注释显示问题处理。

/*************注意*************/

在发布环境中可能会遗失XML文件,解决方法如下:

在项目csproj文件中,添加如下代码:

<PropertyGroup>
    <GenerateDocumentationFile>true</GenerateDocumentationFile>
</PropertyGroup>

重新发布即可。

上一篇:swagger 在线API文档


下一篇:.NetCore3 Api使用Swagger生成api文档