Abp框架(一) :为Swagger接口页添加详细注释

从Abp官网创建完项目之后,启动之后,Swagger的接口说明页,默认是没有接口说明的,这样是很不友好的,也不利于接口调用者的使用,所以,我们要实现Swagger页面的接口注释功能。

BP中已经集成了Swagger,ABP中Swagger,支持动态映射应用层,也就是,无需创建控制器。那么对于自动生成的接口中我们的字段说明和接口说明如何添加呢
首先,我们看一下默认启动后,Swagger的接口页面,标红的是我们自己写的获取所有组织机构的接口,默认是没有注释的。

接下来,我们选中我们Application层的项目,右键“属性”,勾选为Xml生成文档,如下图所示。

image

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

// Set the comments path for the Swagger JSON and UI.
 var xmlFile = @"SCBC.SMES.Application.xml";
 var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
 options.IncludeXmlComments(xmlPath,true);

image

然后再启动项目,可以看到我们的接口有注释啦!!

posted on 2020-09-01 10:18  springsnow  阅读(87)  评论(3编辑  收藏

导航