SwaggerSwagger常⽤注解说明
项⽬中使⽤的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")
param name
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){
Name().toLowerCase().LowerCase())){
result.add(userExample);
}
}
}else{
result.addAll(dataList);
}
return result;
}
效果展⽰:
可以通过response属性，来⾃定义响应的类型.
@ApiParam

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。