项目中使用的swagger注解的版本为swagger-annotations-1.5.13.jar,所以这里只介绍当前版本中注解的使用方式:
一. 常用注解使用例子
@ApiModel
提供有关Swagger模型的其他信息。
类将在操作中用作类型时自动进行内省，但您可能希望操纵模型的结构。
@ApiModel(value = "用户", description = "用户实体")
public class UserExample {
@ApiModelProperty(value = "ID", name = "YvesHeName", example = "0bbfe142-dc16-11e8-accb-7ed6b404f5c3")
private String id;
@ApiModelProperty(value = "用户名")
private String name;
@ApiModelProperty
用于方法，字段上
添加和操作模型属性的数据。
常用例子:
@ApiModel(value = "用户", description = "用户实体")
public class UserExample {
@ApiModelProperty(value = "ID")
private String id;
@ApiModelProperty(value = "用户名")
private String name;
@ApiModelProperty(value = "年龄")
private Integer age;
@ApiModelProperty(value = "地址")
private String address;
@ApiModelProperty(value = "状态: 1:正常 2:冻结 3:已注销")
private Integer status;
@ApiModelProperty(value = "用户配置")
private List<UserConf> userConf;
//省略get,set方法
}
效果图:
@API
用户类上
将类标记为Swagger资源。默认情况下，Swagger-Core仅包含和内省仅使用注释的类，@Api并将忽略其他资源（JAX-RS端点，Servlet等）。
常用例子:
@Api(tags = {"UserExample模块"})
@Controller
@RequestMapping(value = "/users")
public class UserExampleEndpoint {
@ApiOperation
作用于在方法上
描述针对特定路径的操作或通常是HTTP方法。具有等效路径的操作分组在单个操作对象中。HTTP方法和路径的组合创建了一个独特的操作。
使用例子:
@ApiOperation(value = "获取用户列表", notes = "获取用户列表")
@ApiImplicitParams({
@ApiImplicitParam(name = "name", value = "名称", paramType = "query", required = false),
@ApiImplicitParam(name = "sort", value = "排序", paramType = "query", required = false),
@ApiImplicitParam(name = "per_page", value = "每页数量", paramType = "query", required = true),
@ApiImplicitParam(name = "page", value = "当前页码", paramType = "query", required = true),})
@ResponseBody
@RequestMapping(method = RequestMethod.GET, produces = MediaType.APPLICATION_JSON_VALUE)
@ResponseStatus(HttpStatus.OK)
public List<UserExample> _list(
@RequestParam(required = false) String name,
@RequestParam(required = false) String sort,
@RequestParam(required = true) String per_page,
@RequestParam(required = true) String page) {
List<UserExample> result = new ArrayList();
//不处理排序和分页
if (StringUtils.isNotBlank(name)) {
for (UserExample userExample : dataList) {
if (userExample.getName().toLowerCase().contains(name.toLowerCase())) {
result.add(userExample);
}
}
} else {
result.addAll(dataList);
}
return result;
}
效果展示:
可以通过response属性,来自定义响应的类型.
@ApiParam
为操作参数添加其他元数据。此注释只能与JAX-RS 1.x / 2.x注释组合使用。
作用于参数,方法,字段上
使用例子:
使用效果:
参数描述,不指定的时候默认是参数名称,这里也就是user.
关于参数有三种形式:
@RequestBody @ApiParam(value = "用户实体", required = true) UserExample user
默认参数描述为参数名user,可以使用ApiParam注解的value来自定义.
参数是否必须,默认是必须,可以使用ApiParam注解的required来自定义.
总结: 最小的代码侵入配置是不配置ApiParam注解,直接使用默认值.
@PathVariable(value = "id") @ApiParam(value = "ID", required = true) String id
默认参数描述为参数名id,可以使用ApiParam注解的value来自定义.
参数是否必须,默认是必须,可以使用ApiParam注解的required来自定义.
总结: 最小的代码侵入配置是不配置ApiParam注解,直接使用默认值.
@RequestParam(required = true) @ApiParam(value = "每页展示数据", required = true) String per_page
默认参数描述为参数名per_page,可以使用ApiParam注解的value来自定义.
参数是否必须,默认是非必须,可以根据RequestParam注解的属性required 来生效,也可以使用ApiParam注解的required来自定义.
总结: 最小的代码侵入配置是不配置ApiParam注解,直接使用默认值+RequestParam的属性配置.
这里需要注意的是RequestParam的required 属性需要显示的设置.
总结: 如果不需要对参数进行说明的情况下是不需要配置ApiParam注解的
二. 附录: 常用注解说明
@Api：用在请求的类上，表示对类的说明
常用参数：
tags="说明该类的作用，非空时将覆盖value的值"
value="描述类的作用"
其他参数：
description 对api资源的描述，在1.5版本后不再支持
basePath 基本路径可以不配置，在1.5版本后不再支持
position 如果配置多个Api 想改变显示的顺序位置，在1.5版本后不再支持
produces 设置MIME类型列表（output），例："application/json, application/xml"，默认为空
consumes 设置MIME类型列表（input），例："application/json, application/xml"，默认为空
protocols 设置特定协议，例：http， https， ws， wss。
authorizations 获取授权列表（安全声明），如果未设置，则返回一个空的授权值。
hidden 默认为false， 配置为true 将在文档中隐藏
示例：
@Api(tags="登录请求")
@Controller
@RequestMapping(value="/highPregnant")
public class LoginController {}
@ApiOperation：用在请求的方法上，说明方法的用途、作用
常用参数：
value="说明方法的用途、作用"
notes="方法的备注说明"
其他参数：
tags 操作标签，非空时将覆盖value的值
response 响应类型（即返回对象）
responseContainer 声明包装的响应容器（返回对象类型）。有效值为 "List", "Set" or "Map"。
responseReference 指定对响应类型的引用。将覆盖任何指定的response（）类
httpMethod 指定HTTP方法，"GET", "HEAD", "POST", "PUT", "DELETE", "OPTIONS" and "PATCH"
position 如果配置多个Api 想改变显示的顺序位置，在1.5版本后不再支持
nickname 第三方工具唯一标识，默认为空
produces 设置MIME类型列表（output），例："application/json, application/xml"，默认为空
consumes 设置MIME类型列表（input），例："application/json, application/xml"，默认为空
protocols 设置特定协议，例：http， https， ws， wss。
authorizations 获取授权列表（安全声明），如果未设置，则返回一个空的授权值。
hidden 默认为false， 配置为true 将在文档中隐藏
responseHeaders 响应头列表
code 响应的HTTP状态代码。默认 200
extensions 扩展属性列表数组
示例：
@ResponseBody
@PostMapping(value="/login")
@ApiOperation(value = "登录检测", notes="根据用户名、密码判断该用户是否存在")
public UserModel login(@RequestParam(value = "name", required = false) String account,
@RequestParam(value = "pass", required = false) String password){}
@ApiImplicitParams：用在请求的方法上，表示一组参数说明
@ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面
name：参数名，参数名称可以覆盖方法参数名称，路径参数必须与方法参数一致
value：参数的汉字说明、解释
required：参数是否必须传，默认为false [路径参数必填]
paramType：参数放在哪个地方
· header --> 请求参数的获取：@RequestHeader
· query --> 请求参数的获取：@RequestParam
· path（用于restful接口）--> 请求参数的获取：@PathVariable
· body（不常用）
· form（不常用）
dataType：参数类型，默认String，其它值dataType="Integer"
defaultValue：参数的默认值
示例：
@ResponseBody
@PostMapping(value="/login")
@ApiOperation(value = "登录检测", notes="根据用户名、密码判断该用户是否存在")
@ApiImplicitParams({
@ApiImplicitParam(name = "name", value = "用户名", required = false, paramType = "query", dataType = "String"),
@ApiImplicitParam(name = "pass", value = "密码", required = false, paramType = "query", dataType = "String")
})
public UserModel login(@RequestParam(value = "name", required = false) String account,
@RequestParam(value = "pass", required = false) String password){}
其他参数（@ApiImplicitParam）：
allowableValues 限制参数的可接受值。1.以逗号分隔的列表 2、范围值 3、设置最小值/最大值
access 允许从API文档中过滤参数。
allowMultiple 指定参数是否可以通过具有多个事件接受多个值，默认为false
example 单个示例
examples 参数示例。仅适用于BodyParameters
@ApiModel：用于响应类上，表示一个返回响应数据的信息（这种一般用在post创建的时候，使用@RequestBody这样的场景，请求参数无法使用@ApiImplicitParam注解进行描述的时候）
@ApiModelProperty：用在属性上，描述响应类的属性
示例：
@ApiModel(value="用户登录信息", description="用于判断用户是否存在")
public class UserModel implements Serializable{
private static final long serialVersionUID = 1L;
/**
* 用户名
*/
@ApiModelProperty(value="用户名")
private String account;
/**
* 密码
*/
@ApiModelProperty(value="密码")
private String password;
}
其他(@ApiModelProperty)：
value 此属性的简要说明。
name 允许覆盖属性名称
allowableValues 限制参数的可接受值。1.以逗号分隔的列表 2、范围值 3、设置最小值/最大值
access 允许从API文档中过滤属性。
notes 目前尚未使用。
dataType 参数的数据类型。可以是类名或者参数名，会覆盖类的属性名称。
required 参数是否必传，默认为false
position 允许在类中对属性进行排序。默认为0
hidden 允许在Swagger模型定义中隐藏该属性。
example 属性的示例。
readOnly 将属性设定为只读。
reference 指定对相应类型定义的引用，覆盖指定的任何参数值
@ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
code：数字，例如400
message：信息，例如"请求参数没填好"
response：抛出异常的类
示例：
@ResponseBody
@PostMapping(value="/update/{id}")
@ApiOperation(value = "修改用户信息",notes = "打开页面并修改指定用户信息")
@ApiResponses({
@ApiResponse(code=400,message="请求参数没填好"),
@ApiResponse(code=404,message="请求路径没有或页面跳转路径不对")
})
public JsonResult update(@PathVariable String id, UserModel model){}
@ApiParam： 用在请求方法中，描述参数信息
name： 参数名称，参数名称可以覆盖方法参数名称，路径参数必须与方法参数一致
value： 参数的简要说明。
defaultValue： 参数默认值
required: 属性是否必填，默认为false [路径参数必须填]
示例：
@ResponseBody
@PostMapping(value="/login")
@ApiOperation(value = "登录检测", notes="根据用户名、密码判断该用户是否存在")
public UserModel login( @ApiParam(name = "name", value = "用户名", required = false) @RequestParam(value = "name", required = false) String account,
@ApiParam(name = "pass", value = "密码", required = false) @RequestParam(value = "pass", required = false) String password){}
或以实体类为参数：
@ResponseBody
@PostMapping(value="/login")
@ApiOperation(value = "登录检测", notes="根据用户名、密码判断该用户是否存在")
public UserModel login( @ApiParam(name = "model", value = "用户信息Model") UserModel model){}
其他：
allowableValues 限制参数的可接受值。1.以逗号分隔的列表 2、范围值 3、设置最小值/最大值
access 允许从API文档中过滤参数。
allowMultiple 指定参数是否可以通过具有多个事件接受多个值，默认为false
hidden 隐藏参数列表中的参数。
example 单个示例
examples 参数示例。仅适用于BodyParameters
参考:
http://docs.swagger.io/swagger-core/v1.5.0/apidocs/io/swagger/annotations/package-summary.html
