赃物3学习笔记
Swagger3
准备
属国
groupIdio.springfox/groupId
artifactIdspringfox-boot-starter/artifactId
版本3 .0 .0/版本
/依赖性
@EnableOpenApi
常用注解
注解
类
方法
属性
@Api(标签)
标注一个类为时髦的资源，设置资源名称，默认是类名
@ApiOperation(值)
标注一个请求，设置该请求的名称，默认是方法名
@ Apipparam
（不常用)仅用于JAX-RS
@ApiImplicitParam
（常用)功能同@ ApiParame，可用于小型应用程序
@ APIimplicationparams
包裹多个参数描述注解
@ ApiModel
标注一个实体类
@ApiModelProperty
标注实体属性，设置属性的备注信息
@ApiResponse
描述响应码，以及备注信息
@ApiResponses
包裹多个响应描述注解
@ApiIgnore
使时髦的忽略某个资源
使时髦的忽略某个接口
使时髦的忽略某个属性
配置文档信息
@配置
公共类SwaggerConfig {
@豆
公共Docket Docket(){ 0
返回新的文件类型.美洲国家组织_30)。组名(‘ learnswager ‘)。apiInfo(apiInfo())。使能（真);
}
私有ApiInfo ApiInfo(){ 0
返回新的ApiInfoBuilder()。标题(‘测试文档标题)。联系人（新联系人(‘ XTvLi ‘，’ https://github.com/xtyuns ‘，null))。描述(‘测试文档描述信息)。版本(‘ v1.0.0 ‘)。build()；
}
}
详见摘要和ApiInfo的源码
文档资源过滤
@豆
公共Docket Docket(){ 0
返回新的文件类型.美洲国家组织_30)。组名(‘ learnswager ‘)。选择()。路径(s – s.startsWith(‘/v1 ‘)。build()；
}
通过小路选取时可以使用路径选择器，其中提供了any()、none()、ant(antPattern)、regex(pathRegex)方法。
@豆
公共Docket Docket(){ 0
返回新的文件类型.美洲国家组织_30)。组名(‘ learnswager ‘)。选择()。API(RequestHandlerSelectors。BasePackage(‘ com。xtyuns ‘)。API(RequestHandler-)索引-控制器”)。equals(RequestHandler。GroupName()))。build()；
}
//等同于（使用和连结多个选取方法)
@豆
公共Docket Docket(){ 0
返回新的文件类型.美洲国家组织_30)。组名(‘ learnswager ‘)。选择()。API(
requestehandlerselectors。基本包(‘ com。xtyuns ‘)。和（
requestHandler -”索引控制器”。equals(RequestHandler。GroupName())
)
).build()；
}
//默认的选择器
公共静态最终ApiSelector DEFAULT
=新的ApiSelector(
（带类注释)。求反())。和（
(带有方法注释(API忽略。类).求反())、路径选择器。any())；
requestehandlerselectors中也提供了any()、none()、withClassAnnotation(cls)、withMethodAnnotation(cls)方法。
requestHandler.groupName()是类名称的中划线表示法，RequestHandler类中还有一些其他信息可用于进行断言。
文档分组
可以配置多个Docket Bean，必须使用GroupName进行区分。
内容来源网络，如有侵权，联系删除，本文地址：https://www.230890.com/zhan/141439.html