swagger2 註解整體說明最近在使用Swagger的時候忘記了註解的用法，特此記錄一下。

@Api：用在請求的類上，表示對類的說明
   tags="說明該類的作用，可以在UI介面上看到的註解"
   value="該引數沒什麼意義，在UI介面上也看到，所以不需要配置"
 
 @ApiOperation：用在請求的方法上，說明方法的用途、作用
   value="說明方法的用途、作用"
   notes="方法的備註說明"
 
 @ApiImplicitParams：用在請求的方法上，表示一組引數說明
   @ApiImplicitParam：用在@ApiImplicitParams註解中，指定一個請求引數的各個方面
     name：引數名
     value：引數的漢字說明、解釋
     required：引數是否必須傳
     paramType：引數放在哪個地方
       · header --> 請求引數的獲取：@RequestHeader
       · query --> 請求引數的獲取：@RequestParam
       · path（用於restful介面）--> 請求引數的獲取：@PathVariable
       · body（不常用）
       · form（不常用）  
     dataType：引數型別，預設String，其它值dataType="Integer"    
     defaultValue：引數的預設值
 
 @ApiResponses：用在請求的方法上，表示一組響應
   @ApiResponse：用在@ApiResponses中，一般用於表達一個錯誤的響應資訊
     code：數字，例如400
     message：資訊，例如"請求引數沒填好"
     response：丟擲異常的類
 
 @ApiModel：用於響應類上，表示一個返回響應資料的資訊
       （這種一般用在post建立的時候，使用@RequestBody這樣的場景，
       請求引數無法使用@ApiImplicitParam註解進行描述的時候）
   @ApiModelProperty：用在屬性上，描述響應類的屬性

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

 @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：引數的預設值

示例：

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

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

 @ApiResponses：用於請求的方法上，表示一組響應
   @ApiResponse：用在@ApiResponses中，一般用於表達一個錯誤的響應資訊
     code：數字，例如400
     message：資訊，例如"請求引數沒填好"
     response：丟擲異常的類

示例：

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

5. @ApiModel：用於響應類上，表示一個返回響應資料的資訊

 @ApiModel：用於響應類上，表示一個返回響應資料的資訊
       （這種一般用在post建立的時候，使用@RequestBody這樣的場景，
       請求引數無法使用@ApiImplicitParam註解進行描述的時候）
   @ApiModelProperty：用在屬性上，描述響應類的屬性

示例：

 import io.swagger.annotations.ApiModel;
 import io.swagger.annotations.ApiModelProperty;
 import java.io.Serializable;
 @ApiModel(description= "返回響應資料")
 public class RestMessage implements Serializable{
   @ApiModelProperty(value = "是否成功")
   private boolean success=true;
   @ApiModelProperty(value = "返回物件")
   private Object data;
   @ApiModelProperty(value = "錯誤編號")
   private Integer errCode;
   @ApiModelProperty(value = "錯誤資訊")
   private String message;
   /* getter/setter */
 }

總結

到此這篇關於springboot swagger2註解使用的文章就介紹到這了,更多相關springboot swagger2註解使用內容請搜尋我們以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援我們！