swagger2 註解總體說明

@Api：用在請求的類上，表示對類的說明
 2     tags="說明該類的做用，能夠在UI界面上看到的註解"
 3     value="該參數沒什麼意義，在UI界面上也看到，因此不須要配置"
 4 
 5 @ApiOperation：用在請求的方法上，說明方法的用途、做用
 6     value="說明方法的用途、做用"
 7     notes="方法的備註說明"
 8 
 9 @ApiImplicitParams：用在請求的方法上，表示一組參數說明
10     @ApiImplicitParam：用在@ApiImplicitParams註解中，指定一個請求參數的各個方面
11         name：參數名
12         value：參數的漢字說明、解釋
13         required：參數是否必須傳
14         paramType：參數放在哪一個地方
15             · header --> 請求參數的獲取：@RequestHeader
16             · query --> 請求參數的獲取：@RequestParam
17             · path（用於restful接口）--> 請求參數的獲取：@PathVariable
18             · body（不經常使用）
19             · form（不經常使用）    
20         dataType：參數類型，默認String，其它值dataType="Integer"       
21         defaultValue：參數的默認值
22 
23 @ApiResponses：用在請求的方法上，表示一組響應
24     @ApiResponse：用在@ApiResponses中，通常用於表達一個錯誤的響應信息
25         code：數字，例如400
26         message：信息，例如"請求參數沒填好"
27         response：拋出異常的類
28 
29 @ApiModel：用於響應類上，表示一個返回響應數據的信息
30             （這種通常用在post建立的時候，使用@RequestBody這樣的場景，
31             請求參數沒法使用@ApiImplicitParam註解進行描述的時候）
32     @ApiModelProperty：用在屬性上，描述響應類的屬性

1. @Api：用在請求的類上，說明該類的做用

1 @Api：用在請求的類上，說明該類的做用
2     tags="說明該類的做用"
3     value="該參數沒什麼意義，因此不須要配置"

示例: 

1   @Api(tags="APP用戶註冊Controller")

2. @ApiOperation：用在請求的方法上，說明方法的做用

1 @ApiOperation："用在請求的方法上，說明方法的做用"
2     value="說明方法的做用"
3     notes="方法的備註說明"

示例:  

1  @ApiOperation(value="用戶註冊",notes="手機號、密碼都是必輸項，年齡隨邊填，但必須是數字")

3. @ApiImplicitParams：用在請求的方法上，包含一組參數說明

 1 @ApiImplicitParams：用在請求的方法上，包含一組參數說明
 2     @ApiImplicitParam：用在 @ApiImplicitParams 註解中，指定一個請求參數的配置信息       
 3         name：參數名
 4         value：參數的漢字說明、解釋
 5         required：參數是否必須傳
 6         paramType：參數放在哪一個地方
 7             · header --> 請求參數的獲取：@RequestHeader
 8             · query --> 請求參數的獲取：@RequestParam
 9             · path（用於restful接口）--> 請求參數的獲取：@PathVariable
10             · body（不經常使用）
11             · form（不經常使用）    
12         dataType：參數類型，默認String，其它值dataType="Integer"       
13         defaultValue：參數的默認值

示例：

@ApiImplicitParams({
    @ApiImplicitParam(name="mobile",value="手機號",required=true,paramType="form"),
    @ApiImplicitParam(name="password",value="密碼",required=true,paramType="form"),
    @ApiImplicitParam(name="age",value="年齡",required=true,paramType="form",dataType="Integer")
})

4. @ApiResponses：用於請求的方法上，表示一組響應

1 @ApiResponses：用於請求的方法上，表示一組響應
2     @ApiResponse：用在@ApiResponses中，通常用於表達一個錯誤的響應信息
3         code：數字，例如400
4         message：信息，例如"請求參數沒填好"
5         response：拋出異常的類

示例：

1 @ApiOperation(value = "select1請求",notes = "多個參數，多種的查詢參數類型")
2 @ApiResponses({
3     @ApiResponse(code=400,message="請求參數沒填好"),
4     @ApiResponse(code=404,message="請求路徑沒有或頁面跳轉路徑不對")
5 })

5. @ApiModel：用於響應類上，表示一個返回響應數據的信息

1 @ApiModel：用於響應類上，表示一個返回響應數據的信息
2             （這種通常用在post建立的時候，使用@RequestBody這樣的場景，
3             請求參數沒法使用@ApiImplicitParam註解進行描述的時候）
4     @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 }

 

該文章全篇轉載自：https://www.cnblogs.com/jstarseven/p/11458919.html，若有侵權，請聯繫刪除