springboot swagger2注解使用的教程
swagger2 注解整體說明 最近在使用Swagger的時(shí)候忘記了注解的用法,特此記錄一下。
@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)求的類上,說明該類的作用
@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)類的屬性
示例:
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 = "返回對(duì)象")
private Object data;
@ApiModelProperty(value = "錯(cuò)誤編號(hào)")
private Integer errCode;
@ApiModelProperty(value = "錯(cuò)誤信息")
private String message;
/* getter/setter */
}
總結(jié)
到此這篇關(guān)于springboot swagger2注解使用的文章就介紹到這了,更多相關(guān)springboot swagger2注解使用內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
Java開發(fā)或調(diào)用WebService的幾種方式總結(jié)
java開發(fā)過程中,很多地方都會(huì)遇到數(shù)據(jù)傳遞,遠(yuǎn)程獲取數(shù)據(jù)問題,這篇文章主要介紹了Java開發(fā)或調(diào)用WebService的幾種方式的相關(guān)資料,文中通過代碼介紹的非常詳細(xì),需要的朋友可以參考下2024-06-06
JavaSE實(shí)現(xiàn)電影院系統(tǒng)
這篇文章主要為大家詳細(xì)介紹了JavaSE實(shí)現(xiàn)電影院系統(tǒng),文中示例代碼介紹的非常詳細(xì),具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2022-08-08
Springboot整合mybatis-plus使用pageHelper進(jìn)行分頁(使用步驟)
PageHelper是一個(gè)MyBatis分頁插件,可以方便地實(shí)現(xiàn)數(shù)據(jù)庫查詢結(jié)果的分頁功能,在Maven或Gradle項(xiàng)目中引入依賴,并在配置文件中進(jìn)行配置,本文給大家介紹Springboot整合mybatis-plus使用pageHelper進(jìn)行分頁,感興趣的朋友跟隨小編一起看看吧2024-11-11
Spring boot使用spring retry重試機(jī)制的方法示例
這篇文章主要介紹了Spring boot使用spring retry重試機(jī)制的方法示例,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2020-01-01
解決mybatis plus 分頁查詢有條數(shù),total和pages都是零的問題
這篇文章主要介紹了解決mybatis plus 分頁查詢有條數(shù),total和pages都是零的問題,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。一起跟隨小編過來看看吧2020-11-11
Spring+SpringMVC+MyBatis整合實(shí)戰(zhàn)(SSM框架)
框架整合難不難?難!東西多,配置文件復(fù)雜不好記憶,本文就來介紹一下Spring+SpringMVC+MyBatis整合實(shí)戰(zhàn),具有一定的參考價(jià)值,感興趣的可以了解一下2021-08-08
Java類加載之Class對(duì)象到Klass模型詳解
這篇文章主要介紹了Java類加載之Class對(duì)象到Klass模型詳解,每一個(gè)Java類在JVM中都會(huì)對(duì)應(yīng)創(chuàng)建一個(gè)C++類實(shí)例,我們稱這個(gè)C++類為Klass實(shí)例,Klass實(shí)例里面存儲(chǔ)了java類中所描述的方法、字段、屬性等,需要的朋友可以參考下2023-08-08

