swagger集成自动化API文件

1引入POM依赖

com.k4hub
swagger2-spring-boot-starter
1.0-RELEASE

2.启动入口开启swagger文档

3类声明外增加接口说明
@Api(“OA登录接口”)
public class AuthOA {}

4接口方法增加注解说明
@ApiOperation(value = “OA登录”,notes = “OA登录认证”)

样例：@ApiOperation(value = “查询功能列表”,notes = “查询工号功能列表”)

DTO入参统一增加@ApiParam
queryAppClass(@ApiParam(value = “传入json格式”,required = true) @RequestBody InDTO<PubReq> inDTO)
注解参数说明：
@ApiOperation() 用于方法；表示一个http请求的操作
value用于方法描述
notes用于提示内容
tags可以重新分组（视情况而用）
@ApiParam() 用于方法，参数，字段说明；表示对参数的添加元数据（说明或是否必填等）
name–参数名
value–参数说明
required–是否必填
-@ApiModel()用于类 ；表示对类进行说明，用于参数用实体类接收
value–表示对象名
description–描述
都可省略
@ApiModelProperty()用于方法，字段； 表示对model属性的说明或者数据操作更改
value–字段说明
name–重写属性名字
dataType–重写属性类型
required–是否必填
example–举例说明
hidden–隐藏
@ApiIgnore()用于类或者方法上，可以不被swagger显示在页面上
比较简单, 这里不做举例

@ApiImplicitParam() 用于方法
表示单独的请求参数
@ApiImplicitParams() 用于方法，包含多个 @ApiImplicitParam
name–参数ming
value–参数说明
dataType–数据类型
paramType–参数类型
example–举例说明

5。swagger页面请求地址
/swagger-ui.html