@Api：用在請(qǐng)求的類上欢峰，表示對(duì)類的說明
tags="說明該類的作用，可以在UI界面上看到的注解"
value="該參數(shù)沒什么意義涨共，在UI界面上也看到纽帖，所以不需要配置"
@ApiOperation：用在請(qǐng)求的方法上，說明方法的用途举反、作用
value="說明方法的用途抛计、作用"
notes="方法的備注說明"
@ApiImplicitParams：用在請(qǐng)求的方法上，表示一組參數(shù)說明
? ? @ApiImplicitParam：用在@ApiImplicitParams注解中照筑，指定一個(gè)請(qǐng)求參數(shù)的各個(gè)方面
? ? ? ? name：參數(shù)名
? ? ? ? value：參數(shù)的漢字說明吹截、解釋
? ? ? ? required：參數(shù)是否必須傳
? ? ? ? paramType：參數(shù)放在哪個(gè)地方
? ? ? ? ? ? · header --> 請(qǐng)求參數(shù)的獲仁莩隆：@RequestHeader
? ? ? ? ? ? · query --> 請(qǐng)求參數(shù)的獲取：@RequestParam
? ? ? ? ? ? · path（用于restful接口）--> 請(qǐng)求參數(shù)的獲炔ǘ怼：@PathVariable
? ? ? ? ? ? · body（不常用）
? ? ? ? ? ? · form（不常用）? ?
dataType：參數(shù)類型晨逝，默認(rèn)String，其它值dataType="Integer"
? ? ? ? defaultValue：參數(shù)的默認(rèn)值
@ApiResponses：用在請(qǐng)求的方法上懦铺，表示一組響應(yīng)
? ? @ApiResponse：用在@ApiResponses中捉貌，一般用于表達(dá)一個(gè)錯(cuò)誤的響應(yīng)信息
? ? ? ? code：數(shù)字，例如400
message：信息冬念，例如"請(qǐng)求參數(shù)沒填好"
? ? ? ? response：拋出異常的類
@ApiModel：用于響應(yīng)類上趁窃，表示一個(gè)返回響應(yīng)數(shù)據(jù)的信息
? ? ? ? ? ? （這種一般用在post創(chuàng)建的時(shí)候，使用@RequestBody這樣的場(chǎng)景急前，
? ? ? ? ? ? 請(qǐng)求參數(shù)無法使用@ApiImplicitParam注解進(jìn)行描述的時(shí)候）
? ? @ApiModelProperty：用在屬性上醒陆，描述響應(yīng)類的屬性
1、@Api：用在請(qǐng)求的類上裆针，說明該類的作用
tags="說明該類的作用"
value="該參數(shù)沒什么意義刨摩，所以不需要配置"
示例：
@Api(tags="APP用戶注冊(cè)Controller")
2、@ApiOperation：用在請(qǐng)求的方法上世吨，說明方法的作用
@ApiOperation："用在請(qǐng)求的方法上澡刹，說明方法的作用"
value="說明方法的作用"
notes="方法的備注說明"
示例：
@ApiOperation(value="用戶注冊(cè)",notes="手機(jī)號(hào)、密碼都是必輸項(xiàng)耘婚，年齡隨邊填罢浇，但必須是數(shù)字")
3、@ApiImplicitParams：用在請(qǐng)求的方法上沐祷，包含一組參數(shù)說明
@ApiImplicitParams：用在請(qǐng)求的方法上己莺，包含一組參數(shù)說明
@ApiImplicitParam：用在 @ApiImplicitParams 注解中，指定一個(gè)請(qǐng)求參數(shù)的配置信息
name：參數(shù)名
value：參數(shù)的漢字說明戈轿、解釋
required：參數(shù)是否必須傳
paramType：參數(shù)放在哪個(gè)地方
· header --> 請(qǐng)求參數(shù)的獲攘枋堋：@RequestHeader
· query --> 請(qǐng)求參數(shù)的獲取：@RequestParam
· path（用于restful接口）--> 請(qǐng)求參數(shù)的獲人急：@PathVariable
· body（不常用）
· form（不常用）
dataType：參數(shù)類型胜蛉，默認(rèn)String，其它值dataType="Integer"
defaultValue：參數(shù)的默認(rèn)值
示列：
@ApiImplicitParams({
@ApiImplicitParam(name="mobile",value="手機(jī)號(hào)",required=true,paramType="form"),
@ApiImplicitParam(name="password",value="密碼",required=true,paramType="form"),
@ApiImplicitParam(name="age",value="年齡",required=true,paramType="form",dataType="Integer")
})
4色乾、@ApiResponses：用于請(qǐng)求的方法上誊册，表示一組響應(yīng)
@ApiResponses：用于請(qǐng)求的方法上，表示一組響應(yīng)
@ApiResponse：用在@ApiResponses中暖璧，一般用于表達(dá)一個(gè)錯(cuò)誤的響應(yīng)信息
code：數(shù)字案怯，例如400
message：信息，例如"請(qǐng)求參數(shù)沒填好"
response：拋出異常的類
示例：
@ApiOperation(value ="select1請(qǐng)求",notes ="多個(gè)參數(shù)澎办，多種的查詢參數(shù)類型")
@ApiResponses({
@ApiResponse(code=400,message="請(qǐng)求參數(shù)沒填好"),
@ApiResponse(code=404,message="請(qǐng)求路徑?jīng)]有或頁面跳轉(zhuǎn)路徑不對(duì)")
})
5嘲碱、@ApiModel：用于響應(yīng)類上金砍，表示一個(gè)返回響應(yīng)數(shù)據(jù)的信息
@ApiModel：用于響應(yīng)類上，表示一個(gè)返回響應(yīng)數(shù)據(jù)的信息
（這種一般用在post創(chuàng)建的時(shí)候麦锯，使用@RequestBody這樣的場(chǎng)景恕稠，
請(qǐng)求參數(shù)無法使用@ApiImplicitParam注解進(jìn)行描述的時(shí)候）
@ApiModelProperty：用在屬性上，描述響應(yīng)類的屬性
示例:
importio.swagger.annotations.ApiModel;
importio.swagger.annotations.ApiModelProperty;
importjava.io.Serializable;
@ApiModel(description="返回響應(yīng)數(shù)據(jù)")
publicclassRestMessageimplementsSerializable{
@ApiModelProperty(value ="是否成功")
privatebooleansuccess=true;
@ApiModelProperty(value ="返回對(duì)象")
privateObject data;
@ApiModelProperty(value ="錯(cuò)誤編號(hào)")
privateInteger errCode;
@ApiModelProperty(value ="錯(cuò)誤信息")
privateString message;
/* getter/setter */
}
