swager中注解的用途

来源:互联网 发布:南京千米网络怎么样 编辑:程序博客网 时间:2024/05/29 17:44
  1. /**
  2. swagger2使用说明:
  3. @Api:用在类上,说明该类的作用
  4. @ApiOperation:用在方法上,说明方法的作用
  5. @ApiIgnore:使用该注解忽略这个API
  6. @ApiImplicitParams:用在方法上包含一组参数说明
  7. @ApiImplicitParam:用在@ApiImplicitParams注解中,指定一个请求参数的各个方面
  8. paramType:参数放在哪个地方
  9. header-->请求参数的获取:@RequestHeader
  10. query-->请求参数的获取:@RequestParam
  11. path(用于restful接口)-->请求参数的获取:@PathVariable
  12. body(不常用)
  13. form(不常用)
  14. name:参数名
  15. dataType:参数类型
  16. required:参数是否必须传
  17. value:参数的意思
  18. defaultValue:参数的默认值
  19. @ApiResponses:用于表示一组响应
  20. @ApiResponse:用在@ApiResponses中,一般用于表达一个错误的响应信息
  21. code:数字,例如400
  22. message:信息,例如"请求参数没填好"
  23. response:抛出异常的类
  24. @ApiModel:描述一个Model的信息(这种一般用在post创建的时候,使用@RequestBody这样的场景,请求参数无法使用@ApiImplicitParam注解进行描述的时候)
  25. @ApiModelProperty:描述一个model的属性
  26. */