亚洲激情专区-91九色丨porny丨老师-久久久久久久女国产乱让韩-国产精品午夜小视频观看

溫馨提示×

溫馨提示×

您好,登錄后才能下訂單哦!

密碼登錄×
登錄注冊×
其他方式登錄
點擊 登錄注冊 即表示同意《億速云用戶服務條款》

springboot swagger2注解的用法

發布時間:2020-07-27 15:21:34 來源:億速云 閱讀:131 作者:小豬 欄目:編程語言

這篇文章主要講解了springboot swagger2注解的用法,內容清晰明了,對此有興趣的小伙伴可以學習一下,相信大家閱讀完之后會有幫助。

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="密碼",required=true,paramType="form"),
   @ApiImplicitParam(name="age",value="年齡",required=true,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注解的用法有進一步的了解,如果還想學習更多內容,歡迎關注億速云行業資訊頻道。

向AI問一下細節

免責聲明:本站發布的內容(圖片、視頻和文字)以原創、轉載和分享為主,文章觀點不代表本網站立場,如果涉及侵權請聯系站長郵箱:is@yisu.com進行舉報,并提供相關證據,一經查實,將立刻刪除涉嫌侵權內容。

AI

定西市| 蒙自县| 郓城县| 克什克腾旗| 岱山县| 明水县| 鲁山县| 翁源县| 兰溪市| 台北县| 社旗县| 屏边| 正阳县| 黔江区| 伊通| 昭通市| 板桥市| 皮山县| 湘西| 台湾省| 花莲市| 凤翔县| 萨迦县| 遵义县| 白玉县| 萍乡市| 崇礼县| 林周县| 武夷山市| 邻水| 马山县| 鄂温| 鲁甸县| 巴彦淖尔市| 介休市| 峨眉山市| 四平市| 长葛市| 互助| 博客| 吉林省|