swagger2注解使用教程
前言
Swagger，可用于生成、描述、调用和可视化 RESTful 风格接口的API，是一套规范和完整的开发框架，并且能对接口进行单独测试，本文记录在swagger中常用注解
swagger2 注解整体说明
1 |
|
swagger2 使用详细说明
@Api
使用说明
1
2
3：用在请求的类上，说明该类的作用
tags="说明该类的作用"
value="该参数没什么意义，所以不需要配置"示例
1
(tags="APP用户注册Controller")
ApiOperation
使用说明
1
2
3："用在请求的方法上，说明方法的作用"
value="说明方法的作用"
notes="方法的备注说明"示例
1
(value="用户注册",notes="手机号、密码都是必输项，年龄随边填，但必须是数字")
ApiImplicitParams
使用说明
1
2
3
4
5
6
7
8
9
10
11
12
13：用在请求的方法上，包含一组参数说明
：用在 注解中，指定一个请求参数的配置信息
name：参数名
value：参数的汉字说明、解释
required：参数是否必须传
paramType：参数放在哪个地方
· header --> 请求参数的获取：
· query --> 请求参数的获取：
· path（用于restful接口）--> 请求参数的获取：
· body（不常用）
· form（不常用）
dataType：参数类型，默认String，其它值dataType="Integer"
defaultValue：参数的默认值示例
1 | ({ |
ApiResponses
使用说明
1
2
3
4
5：用于请求的方法上，表示一组响应
：用在中，一般用于表达一个错误的响应信息
code：数字，例如400
message：信息，例如"请求参数没填好"
response：抛出异常的类示例
1
2
3
4
5(value = "select1请求",notes = "多个参数，多种的查询参数类型")
({
(code=400,message="请求参数没填好"),
(code=404,message="请求路径没有或页面跳转路径不对")
})
ApiModel
使用说明
1
2
3
4：用于响应类上，表示一个返回响应数据的信息
（这种一般用在post创建的时候，使用这样的场景，
请求参数无法使用注解进行描述的时候）
：用在属性上，描述响应类的属性示例
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.io.Serializable;
(description= "返回响应数据")
public class RestMessage implements Serializable{
(value = "是否成功")
private boolean success=true;
(value = "返回对象")
private Object data;
(value = "错误编号")
private Integer errCode;
(value = "错误信息")
private String message;
/* getter/setter */
}