這篇文章主要講解了springboot swagger2注解的用法,內(nèi)容清晰明了,對此有興趣的小伙伴可以學習一下,相信大家閱讀完之后會有幫助。
創(chuàng)新互聯(lián)建站長期為千余家客戶提供的網(wǎng)站建設服務,團隊從業(yè)經(jīng)驗10年,關注不同地域、不同群體,并針對不同對象提供差異化的產(chǎn)品和服務;打造開放共贏平臺,與合作伙伴共同營造健康的互聯(lián)網(wǎng)生態(tài)環(huán)境。為白水企業(yè)提供專業(yè)的成都網(wǎng)站設計、成都做網(wǎng)站,白水網(wǎng)站改版等技術服務。擁有10余年豐富建站經(jīng)驗和眾多成功案例,為您定制開發(fā)。swagger2 注解整體說明 最近在使用Swagger的時候忘記了注解的用法,特此記錄一下。
@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ù)類型,默認String,其它值dataType="Integer" defaultValue:參數(shù)的默認值 @ApiResponses:用在請求的方法上,表示一組響應 @ApiResponse:用在@ApiResponses中,一般用于表達一個錯誤的響應信息 code:數(shù)字,例如400 message:信息,例如"請求參數(shù)沒填好" response:拋出異常的類 @ApiModel:用于響應類上,表示一個返回響應數(shù)據(jù)的信息 (這種一般用在post創(chuàng)建的時候,使用@RequestBody這樣的場景, 請求參數(shù)無法使用@ApiImplicitParam注解進行描述的時候) @ApiModelProperty:用在屬性上,描述響應類的屬性
另外有需要云服務器可以了解下創(chuàng)新互聯(lián)建站www.cdcxhl.com,海內(nèi)外云服務器15元起步,三天無理由+7*72小時售后在線,公司持有idc許可證,提供“云服務器、裸金屬服務器、高防服務器、香港服務器、美國服務器、虛擬主機、免備案服務器”等云主機租用服務以及企業(yè)上云的綜合解決方案,具有“安全穩(wěn)定、簡單易用、服務可用性高、性價比高”等特點與優(yōu)勢,專為企業(yè)上云打造定制,能夠滿足用戶豐富、多元化的應用場景需求。