@Api：用在請求的類上，表示對類的說明tags="說明該類的作用，可以在UI界面上看到的注解"value="該參數(shù)沒什么意義，在UI界面上也看到，所以不需要配置"@ApiOperation：用在請求的方法上，說明方法的用途、作用value="說明方法的用途、作用"notes="方法的備注說明"@ApiImplicitParams：用在請求的方法上，表示一組參數(shù)說明@ApiImplicitParam：用在@ApiImplicitParams注解中，指定一個請求參數(shù)的各個方面name：參數(shù)名value：參數(shù)的漢字說明、解釋required：參數(shù)是否必須傳paramType：參數(shù)放在哪個地方· header --> 請求參數(shù)的獲取：@RequestHeader· query --> 請求參數(shù)的獲取：@RequestParam· path（用于restful接口）--> 請求參數(shù)的獲取：@PathVariable· body（不常用）· form（不常用） dataType：參數(shù)類型，默認(rèn)String，其它值dataType="Integer" defaultValue：參數(shù)的默認(rèn)值@ApiResponses：用在請求的方法上，表示一組響應(yīng)@ApiResponse：用在@ApiResponses中，一般用于表達(dá)一個錯誤的響應(yīng)信息code：數(shù)字，例如400message：信息，例如"請求參數(shù)沒填好"response：拋出異常的類@ApiModel：用于響應(yīng)類上，表示一個返回響應(yīng)數(shù)據(jù)的信息（這種一般用在post創(chuàng)建的時候，使用@RequestBody這樣的場景，請求參數(shù)無法使用@ApiImplicitParam注解進(jìn)行描述的時候）@ApiModelProperty：用在屬性上，描述響應(yīng)類的屬性

1、@Api：用在請求的類上，說明該類的作用
? ? ?tags="說明該類的作用"
? ? ?value="該參數(shù)沒什么意義，所以不需要配置"
示例：

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

2、@ApiOperation：用在請求的方法上，說明方法的作用
@ApiOperation："用在請求的方法上，說明方法的作用"
? ? value="說明方法的作用"
? ? notes="方法的備注說明"
示例：

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

3、@ApiImplicitParams：用在請求的方法上，包含一組參數(shù)說明
? ? ?@ApiImplicitParams：用在請求的方法上，包含一組參數(shù)說明
? ? ?@ApiImplicitParam：用在 @ApiImplicitParams 注解中，指定一個請求參數(shù)的配置信息 ? ? ??
? ? ? ? name：參數(shù)名
? ? ? ? value：參數(shù)的漢字說明、解釋
? ? ? ? required：參數(shù)是否必須傳
? ? ? ? paramType：參數(shù)放在哪個地方
? ? ? ? ? ? · header --> 請求參數(shù)的獲取：@RequestHeader
? ? ? ? ? ? · query --> 請求參數(shù)的獲取：@RequestParam
? ? ? ? ? ? · path（用于restful接口）--> 請求參數(shù)的獲取：@PathVariable
? ? ? ? ? ? · body（不常用）
? ? ? ? ? ? · form（不常用） ? ?
? ? ? ? dataType：參數(shù)類型，默認(rèn)String，其它值dataType="Integer" ? ? ??
? ? ? ? defaultValue：參數(shù)的默認(rèn)值

示列：

@ApiImplicitParams({@ApiImplicitParam(name="mobile",value="手機(jī)號",required=true,paramType="form"),@ApiImplicitParam(name="password",value="密碼",required=true,paramType="form"),@ApiImplicitParam(name="age",value="年齡",required=true,paramType="form",dataType="Integer") }) 4、@ApiResponses：用于請求的方法上，表示一組響應(yīng)

? ? ?@ApiResponses：用于請求的方法上，表示一組響應(yīng)
? ? ?@ApiResponse：用在@ApiResponses中，一般用于表達(dá)一個錯誤的響應(yīng)信息
? ? ? ? code：數(shù)字，例如400
? ? ? ? message：信息，例如"請求參數(shù)沒填好"
? ? ? ? response：拋出異常的類
示例：

@ApiOperation(value = "select1請求",notes = "多個參數(shù)，多種的查詢參數(shù)類型") @ApiResponses({@ApiResponse(code=400,message="請求參數(shù)沒填好"),@ApiResponse(code=404,message="請求路徑?jīng)]有或頁面跳轉(zhuǎn)路徑不對") })

5、@ApiModel：用于響應(yīng)類上，表示一個返回響應(yīng)數(shù)據(jù)的信息
? ? ?@ApiModel：用于響應(yīng)類上，表示一個返回響應(yīng)數(shù)據(jù)的信息
? ? ? ? ? ? （這種一般用在post創(chuàng)建的時候，使用@RequestBody這樣的場景，
? ? ? ? ? ? 請求參數(shù)無法使用@ApiImplicitParam注解進(jìn)行描述的時候）
? ? ?@ApiModelProperty：用在屬性上，描述響應(yīng)類的屬性

示例:

import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty;import java.io.Serializable;@ApiModel(description= "返回響應(yīng)數(shù)據(jù)") 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 */ }

?

總結(jié)

以上是生活随笔為你收集整理的swagger2 注解说明 ( @ApiImplicitParams )的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。