-
Swagger接口页添加接口注释和参数注释
从Abp官网创建完项目之后,启动之后,Swagger的接口说明页,默认是没有接口说明的,这样是很不友好的,也不利于接口调用者的使用,所以,我们要实现Swagger页面的接口注释功能。
首先,我们看一下默认启动后,Swagger的接口页面,标红的是我们自己写的获取所有组织机构的接口,默认是没有注释的。
接下来,我们选中我们Application层的项目,右键“属性”,将输出路径选择为“bin\Debug\”,然后再勾选为Xml生成文档,如下图所示。
接下来,在你的 项目名.Web.Host 的startup目录下,找到StartUp.cs类,在它的ConfigureServices方法中,找到配置Swagger的代码块,将生成的Xml配置进去。核心代码如下:
//将application层的注释添加的swaggerui中
var baseDirectory = AppDomain.CurrentDomain.BaseDirectory;
var CommentsFileName = @"YiGong.Application.OA.xml";
var CommentsFile = Path.Combine(baseDirectory, CommentsFileName);
//将注释的Xml文档添加到swaggerUi中
options.IncludeXmlComments(CommentsFile);
然后再启动项目,可以看到我们的接口有注释啦!!