swagger2 注解说明 ( @ApiImplicitParams )

末蓝、 2024-04-19 15:37 103阅读 0赞

1.  `@Api：用在请求的类上，表示对类的说明`
2.  `tags="说明该类的作用，可以在UI界面上看到的注解"`
3.  `value="该参数没什么意义，在UI界面上也看到，所以不需要配置"`
4.   
5.   
6.  `@ApiOperation：用在请求的方法上，说明方法的用途、作用`
7.  `value="说明方法的用途、作用"`
8.  `notes="方法的备注说明"`
9.   
10.  
11. `@ApiImplicitParams：用在请求的方法上，表示一组参数说明`
12. `@ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面`
13. `name：参数名`
14. `value：参数的汉字说明、解释`
15. `required：参数是否必须传`
16. `paramType：参数放在哪个地方`
17. `· header --> 请求参数的获取：@RequestHeader`
18. `· query --> 请求参数的获取：@RequestParam`
19. `· path（用于restful接口）--> 请求参数的获取：@PathVariable`
20. `· body（不常用）`
21. `· form（不常用）`
22. `dataType：参数类型，默认String，其它值dataType="Integer"`
23. `defaultValue：参数的默认值`
24.  
25.  
26. `@ApiResponses：用在请求的方法上，表示一组响应`
27. `@ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息`
28. `code：数字，例如400`
29. `message：信息，例如"请求参数没填好"`
30. `response：抛出异常的类`
31.  
32.  
33. `@ApiModel：用于响应类上，表示一个返回响应数据的信息`
34. `（这种一般用在post创建的时候，使用@RequestBody这样的场景，`
35. `请求参数无法使用@ApiImplicitParam注解进行描述的时候）`
36. `@ApiModelProperty：用在属性上，描述响应类的属性`

1、@Api：用在请求的类上，说明该类的作用  
     tags="说明该类的作用"  
     value="该参数没什么意义，所以不需要配置"  
示例：

@Api(tags="APP用户注册Controller")

2、@ApiOperation：用在请求的方法上，说明方法的作用  
@ApiOperation："用在请求的方法上，说明方法的作用"  
    value="说明方法的作用"  
    notes="方法的备注说明"  
示例：

@ApiOperation(value="用户注册",notes="手机号、密码都是必输项，年龄随边填，但必须是数字")

3、@ApiImplicitParams：用在请求的方法上，包含一组参数说明  
     @ApiImplicitParams：用在请求的方法上，包含一组参数说明  
     @ApiImplicitParam：用在 @ApiImplicitParams 注解中，指定一个请求参数的配置信息         
        name：参数名  
        value：参数的汉字说明、解释  
        required：参数是否必须传  
        paramType：参数放在哪个地方  
            · header --> 请求参数的获取：@RequestHeader  
            · query --> 请求参数的获取：@RequestParam  
            · path（用于restful接口）--> 请求参数的获取：@PathVariable  
            · body（不常用）  
            · form（不常用）      
        dataType：参数类型，默认String，其它值dataType="Integer"         
        defaultValue：参数的默认值

示列：

1.  `@ApiImplicitParams({`
2.  `    @ApiImplicitParam(name="mobile",value="手机号",required=true,paramType="form"),`
3.  `    @ApiImplicitParam(name="password",value="密码",required=true,paramType="form"),`
4.  `    @ApiImplicitParam(name="age",value="年龄",required=true,paramType="form",dataType="Integer")`
5.  `})`

4、@ApiResponses：用于请求的方法上，表示一组响应  
     @ApiResponses：用于请求的方法上，表示一组响应  
     @ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息  
        code：数字，例如400  
        message：信息，例如"请求参数没填好"  
        response：抛出异常的类  
示例：

1.  `@ApiOperation(value = "select1请求",notes = "多个参数，多种的查询参数类型")`
2.  `@ApiResponses({`
3.  `    @ApiResponse(code=400,message="请求参数没填好"),`
4.  `    @ApiResponse(code=404,message="请求路径没有或页面跳转路径不对")`
5.  `})`

5、@ApiModel：用于响应类上，表示一个返回响应数据的信息  
     @ApiModel：用于响应类上，表示一个返回响应数据的信息  
            （这种一般用在post创建的时候，使用@RequestBody这样的场景，  
            请求参数无法使用@ApiImplicitParam注解进行描述的时候）  
     @ApiModelProperty：用在属性上，描述响应类的属性

示例:

1.  `import io.swagger.annotations.ApiModel;`
2.  `import io.swagger.annotations.ApiModelProperty;`
3.   
4.  `import java.io.Serializable;`
5.   
6.  `@ApiModel(description= "返回响应数据")`
7.  `public class RestMessage implements Serializable{`
8.   
9.  `    @ApiModelProperty(value = "是否成功")`
10. `    private boolean success=true;`
11. `    @ApiModelProperty(value = "返回对象")`
12. `    private Object data;`
13. `    @ApiModelProperty(value = "错误编号")`
14. `    private Integer errCode;`
15. `    @ApiModelProperty(value = "错误信息")`
16. `    private String message;`
17.  
18. `    /* getter/setter */`
19. `}`