swagger-ui常用注解

swagger-ui介绍：

swagger-ui是一个通过注解自动生成接口文档的技术，这样我们在修改后端接口时，就可以将文档实时同步更新了

下面我们来介绍一下常用的注解

@Api (修饰类)

常见参数

value : 类的作用

tags : 非空时会覆盖value的值，可以在ui界面上看到

produces : 设置输出的mime类型，比如 “application/json”

consumes : 设置输入的mime类型，比如 “application/json”

protocols ：安全协议，比如http, https

authorizations : 安全声明

hidden ：是否在界面上展示

@ApiOperation(修饰方法)

value: 方法介绍

notes:备注说明

tags : 非空时会覆盖value的值

response : 响应类型

httpMethod : 指定的http方法

responseHeaders : 响应头列表

code ： 响应的http状态码

produces : 设置输出的mime类型，比如 “application/json”

consumes : 设置输入的mime类型，比如 “application/json”

protocols ：安全协议，比如http, https

authorizations : 安全声明

hidden ：是否在界面上展示

@ApiParam (接收参数)

name : 参数名称， 和前端传递过来的保持一致

value : 参数的说明

defaultValue : 参数默认值

required : 是否必填

@ApiModel （修饰参数对象类）

value : 类介绍

description : 详细介绍

@ApiModelProperty（修饰参数对象类上的具体字段）

value ： 字段含义