江苏龙网

  1. 首页 > 人文 > >

Swagger2—API文档框架（二）

【Swagger2】
五、Swagger配置可以在项目中创建SwaggerConfig ， 进行配置文档内容 。
1、配置基本信息
Docket：摘要对象 ， 通过对象配置描述文件的信息 。
apiInfo：设置描述文件中info 。 参数类型ApiInfo
select()：返回ApiSelectorBuilder对象 ， 通过对象调用build()可以创建Docket对象
ApiInfoBuilder：ApiInfo构建器 。
Swagger2—API文档框架（二）文章插图
显示效果如下：
Swagger2—API文档框架（二）文章插图
2、设置扫描的包
可以通过apis()方法设置哪个包中内容被扫描
Swagger2—API文档框架（二）文章插图
3、自定义注解设置不需要生成接口文档的方法
3.1 自定义注解
注解名称随意 。
Swagger2—API文档框架（二）文章插图
3.2 添加规则
通过public ApiSelectorBuilder apis(Predicate selector)可以设置生成规则 。
public staticPredicate not(Predicate predicate) :表示不允许的条件 。
withMethodAnnotation：表示此注解是方法级别注解 。
Swagger2—API文档框架（二）文章插图
【Swagger2—API文档框架（二）】3.3 添加NotIncludeSwagger注解
在不需要生成接口文档的方法上面添加@NotIncludeSwagger注解后 ， 该方法将不会被Swagger进行生成在接口文档中 。
Swagger2—API文档框架（二）文章插图
4、设置范围
通过public ApiSelectorBuilder paths(Predicate selector)可以设置满足什么样规则的url被生成接口文档 。 可以使用正则表达式进行匹配 。
下面例子中表示只有以/demo/开头的url才能被swagger生成接口文档 。
如何希望全部扫描可以使用paths(PathSelectors.any())
Swagger2—API文档框架（二）文章插图
六、Swagger2常用注解1、Api
@Api是类上注解 。 控制整个类生成接口信息的内容 。
tags：类的名称 。 可以有多个值 ， 多个值表示多个副本 。
description：描述 ， 已过时 。
Swagger2—API文档框架（二）文章插图
在swagger-ui.html中显示效果 。
Swagger2—API文档框架（二）文章插图
2、ApiOperation
@ApiOperation写在方法上 ， 对方法进行总体描述
● value：接口描述
● notes：提示信息
代码示例：
Swagger2—API文档框架（二）文章插图
在swagger-ui中显示效果
Swagger2—API文档框架（二）文章插图
3、ApiParam
@ApiParam写在方法参数前面 。 用于对参数进行描述或说明是否为必添项等说明 。
name：参数名称
value：参数描述
required：是否是必须
Swagger2—API文档框架（二）文章插图
swagger-ui显示效果如下：
Swagger2—API文档框架（二）文章插图


推荐阅读


上一篇：电竞显示器怎么选？可以来看看MSI MAG251RX

下一篇：vivo折叠屏专利曝光 铰链处藏笔设计有新意