Abp 为Swagger接口页添加详细注释

 从Abp官网创建完项目之后，启动之后，Swagger的接口说明页，默认是没有接口说明的，这样是很不友好的，也不利于接口调用者的使用，所以，我们要实现Swagger页面的接口注释功能。
       首先，我们看一下默认启动后，Swagger的接口页面，标红的是我们自己写的获取所有组织机构的接口，默认是没有注释的。

 

  接下来，我们选中我们Application层的项目，右键“属性”，将输出路径选择为“bin\Debug\”，然后再勾选为Xml生成文档，如下图所示。

接下来，在你的 项目名.Web.Host 的startup目录下，找到StartUp.cs类，在它的ConfigureServices方法中，找到配置Swagger的代码块(services.AddSwaggerGen)，将生成的Xml配置进去。核心代码如下：

 var basePath = Path.GetDirectoryName(typeof(Program).Assembly.Location);//获取应用程序所在目录（绝对，不受工作目录影响，建议采用此方法获取路径）
                var xmlPath = Path.Combine(basePath, "HealthCenter.Web.Host.xml");   //  添加 swagger xml 注释  这个xml文件开始是不存在的写上项目名.xml即可
                options.IncludeXmlComments(xmlPath);

 然后再启动项目，可以看到我们的接口有注释了