Swagger注解详解

目录

1. @Api

2. @APiOperation

3. @ApiImplicitParams

4. @ApiResponses

5. @ApiModel

6. @ApiModelProperty

---

这里是说明常用注解的含义和基本用法（也就是说已经对swagger进行集成完成） 
没有集成的请参见 
SpringBoot集成springfox-swagger2构建restful API 
SpringMVC集成springfox-swagger2构建restful API 

1. @Api

协议集描述，用在Controller类上

• value - 字段说明
• tags- 注释说明这个类

2. @APiOperation

协议描述，用在Controller方法上，一般有value和notes

• value - 字段说明
• notes - 注释说明
• httpMethod - 说明这个方法被请求的方式
• response - 方法的返回值的类型

3. @ApiImplicitParams

非对象描述参数集，用在Controller方法上，里面可以加多个@ApiImplicitParam

一般在GET请求上面加

name：参数名

value：参数的汉字说明、解释

required：参数是否必须传

dataType：参数类型，默认String，其它值dataType="Integer"

defaultValue：参数的默认值

paramType：参数放在哪个地方

• header --> 请求参数的获取：@RequestHeader
• query --> 请求参数的获取：@RequestParam
• path（用于restful接口）--> 请求参数的获取：@PathVariable
• body（不常用）
• form（不常用）

4. @ApiResponses

表示一组响应，用在Controller方法上，@ApiResponse一般用于表达一个错误的响应信息。

• code：数字，例如400

• message：信息，例如"请求参数没填好"

• response：抛出异常的类

5. @ApiModel

表示一个返回响应数据的信息，用于响应类上

• （这种一般用在post创建的时候，使用@RequestBody这样的场景，

• 请求参数无法使用@ApiImplicitParam注解进行描述的时候）

• @ApiModel("类的描述")

6. @ApiModelProperty

描述响应类的属性，用在属性上。

• @ApiModelProperty("属性描述")