1. 首頁 > 云知道 > >

swagger2注解詳細說明 swagger歌曲

云知道心理情感

@Api：用在請求的類上，表示對類的說明 tags="說明該類的作用，可以在UI界面上看到的注解" value="http://www.gzkyz.com.cn/article/該參數沒什么意義，在UI界面上也看到，所以不需要配置" @ApiOperation：用在請求的方法上，說明方法的用途、作用 value="http://www.gzkyz.com.cn/article/說明方法的用途、作用" 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：用在屬性上，描述響應類的屬性@Api：用在請求的類上，說明該類的作用
@Api：用在請求的類上，說明該類的作用 tags="說明該類的作用" value="http://www.gzkyz.com.cn/article/該參數沒什么意義，所以不需要配置"@ApiOperation：用在請求的方法上，說明方法的作用
@ApiOperation："用在請求的方法上，說明方法的作用" value="http://www.gzkyz.com.cn/article/說明方法的作用" notes="方法的備注說明"示例：
@ApiOperation(value="http://www.gzkyz.com.cn/article/用戶注冊",notes="手機號、密碼都是必輸項，年齡隨邊填，但必須是數字")
@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="http://www.gzkyz.com.cn/article/手機號",required=true,paramType="form"), @ApiImplicitParam(name="password",value="http://www.gzkyz.com.cn/article/密碼",required=true,paramType="form"), @ApiImplicitParam(name="age",value="http://www.gzkyz.com.cn/article/年齡",required=true,paramType="form",dataType="Integer")})【swagger2注解詳細說明 swagger歌曲】@ApiResponses：用于請求的方法上，表示一組響應
@ApiResponses：用于請求的方法上，表示一組響應 @ApiResponse：用在@ApiResponses中，一般用于表達一個錯誤的響應信息 code：數字，例如400 message：信息，例如"請求參數沒填好" response：拋出異常的類示例
@ApiOperation(value = "http://www.gzkyz.com.cn/article/select1請求",notes = "多個參數，多種的查詢參數類型")@ApiResponses({ @ApiResponse(code=400,message="請求參數沒填好"), @ApiResponse(code=404,message="請求路徑沒有或頁面跳轉路徑不對")})@ApiModel：用于響應類上，表示一個返回響應數據的信息
@ApiModel：用于響應類上，表示一個返回響應數據的信息 （這種一般用在post創建的時候，使用@RequestBody這樣的場景，請求參數無法使用@ApiImplicitParam注解進行描述的時候） @ApiModelProperty：用在屬性上，描述響應類的屬性示例

推薦閱讀