Swagger注解详解

Swagger注解详解

1.1 @Api

用在类上,说明该类的作用

比如说:@Api(value = “UserController”, description = “用户相关api”)

 

1.2 @ApiOperation

用在方法上,说明方法的作用

比如说:
@ApiOperation(value = “查找用户”, notes = “查找用户”, httpMethod = “GET”, produces = MediaType.APPLICATION_JSON_UTF8_VALUE)

 

 

1.3  @ApiImplicitParams

用在方法上包含一组参数说明
paramType:参数放在哪个地方
header–>请求参数的获取:@RequestHeader
query–>请求参数的获取:@RequestParam
path(用于restful接口)–>请求参数的获取:@PathVariable
body(不常用)
form(不常用)
name:参数名
dataType:参数类型
required:参数是否必须传
value:参数的意思
defaultValue:参数的默认值

比如说:

 

1.4 @ApiResponses

@ApiResponses用于表示一组响应

 

1.5  @ApiResponse

 

 

1.6  @ApiModel

描述一个Model的信息(这种一般用在post创建的时候,使用@RequestBody这样的场景,请求参数无法使用@ApiImplicitParam注解进行描述的时候)
@ApiModel(value = “用户实体类”)

 

1.7  @ApiModelProperty

描述一个model的属性
@ApiModelProperty(value = “登录用户”)

 

 






如果您认为本教程质量不错,读后觉得收获很大,预期工资能蹭蹭蹭的往上涨,那么不妨小额赞助我一下,让我有动力继续写出高质量的教程。

发布者

souvc

souvc

搜你所想,投你所好。

《Swagger注解详解》有55个想法

  1. Pingback: DMPK
  2. Pingback: juegos friv
  3. Pingback: TS Escorts
  4. Pingback: Wedding Planners
  5. Pingback: Law Diyala
  6. Pingback: iraqi Seo
  7. Pingback: https://goo.gl/RfxWPu
  8. Pingback: coe
  9. Pingback: GVK BIO Latest News
  10. Pingback: GVK Biosciences
  11. Pingback: Yusuf kısa
  12. Pingback: pendaftaran cpns 2018
  13. Pingback: cmovieshd
  14. Pingback: 검증사이트
  15. Pingback: 威尼斯人网站vns
  16. Pingback: free forex signals
  17. Pingback: Child Pornography
  18. Pingback: forex signals
  19. Pingback: tutorial
  20. Pingback: telefoonhoesjes
  21. Pingback: Banja Luka
  22. Pingback: comprar esteroides
  23. Pingback: http://tsn.us.com/
  24. Pingback: Free UK Chat
  25. Pingback: redeem
  26. Pingback: underage naked
  27. Pingback: complex PK studies
  28. Pingback: in vitro PK screening
  29. Pingback: Déménageurs
  30. Pingback: Teen Chat Rooms
  31. Pingback: happiercitizens.com
  32. Pingback: fotbollströjor
  33. Pingback: kiln dried logs
  34. Pingback: 2019
  35. Pingback: cleantalkorg2.ru
  36. Pingback: #macron #Lassalle
  37. Pingback: a2019-2020
  38. Pingback: facebook
  39. Pingback: facebook1
  40. Pingback: javsearch.mobi

发表评论