Abp框架从零开始(基于.Net Core 2.2) 小记(一) 为Swagger接口页添加详细注释

风中喝粥

于 2019-08-02 11:51:56 发布

阅读量1.3k

点赞数 1

CC 4.0 BY-SA版权

本文链接：https://blog.youkuaiyun.com/war3ismylove/article/details/98182680

Abp框架从零开始(基于.Net Core 2.x) 专栏收录该内容

2 篇文章

订阅专栏

本文介绍如何在ABP框架中为Swagger界面添加接口和参数注释，通过配置XML文档生成和SwaggerUI的集成，提升接口文档的友好性和实用性。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

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);