swagger2 常用註解的使用

2022-04-16 15:16:22 字數 1591 閱讀 1149

一、@api  

效果:

@api註解放在類上面,這裡的value是沒用的,tags表示該controller的介紹。

二 、@apioperation

效果:

@apioperation註解用於放在方法上面,其中value是該類的簡短的敘述,notes一般是該方法的詳細描述。

三、@apiimplicitparam 與 @

@apiimplicitparam註解用於表明前端傳入的name引數的名字,required是否為必需項,以及datatype引數型別,以及paramtype傳遞方式(query表示使用url問號的方式傳參,這種比較常用,如果使用formdata的方式進行傳參,那麼paramtype的值為 form).

當有多個引數時,需要用@apiimplicitparams將@apiimplicitparam包起來

四、如果傳遞的是pojo型別的引數

在ui.html中

這裡的data type為 model,此時我們可以在實體類的**中新增註解,選擇我們需要在這裡顯示的屬性。如下:

@apimodelproperty(hidden =true)表示不需要在swagger頁面進行展示,required表示該屬性為必需的屬性。
結果如下:

五、如果上傳的是**檔案型別

寫在最後,在使用swagger的時候可能會遇到的bug,當前後端的傳遞引數的名稱對應上之後,後台仍然無法接收到引數,這可能是因為我們沒有加上request相關的說明,如@requestparam @requestbody  required=true 等。這樣會導致 從swagger.ui.html中傳遞過來的引數後台無法接收到。但是在正常的開發過程中我們是即使不寫這幾個request相關的註解,只要屬性的名字可能對應上,那麼後台也是可能正常接受到引數的。這也許是swagger2中隱藏的乙個bug。

swagger2常用註解說明

說明 1.這裡使用的版本 springfox swagger2 2.4 springfox swagger ui 2.4 2.這裡是說明常用註解的含義和基本用法 也就是說已經對swagger進行整合完成 沒有整合的請參見 springboot整合springfox swagger2構建restful...

swagger2常用註解說明

引入swagger的版本測試為 io.springfox springfox swagger2 2.2.2 api 用於類 可選值 value,tags,description.可以自行檢視原始碼 片段 效果圖 用於方法 表示乙個http請求的操作 value用於方法描述 notes用於提示內容 a...

swagger2常用註解說明

原文 說明 1.這裡使用的版本 springfox swagger2 2.4 springfox swagger ui 2.4 2.這裡是說明常用註解的含義和基本用法 也就是說已經對swagger進行整合完成 沒有整合的請參見 springboot整合springfox swagger2構建rest...