Swagger註解及引數細節的正確書寫。

2022-01-23 06:44:52 字數 759 閱讀 6823

今天新開了乙個api檔案,結果怎麼搞也在swagger裡顯示不出來,浪費半天後,去問老員工了。

一般有倆原因,

1.idea快取,重啟idea即可。

2.註解和引數上的修飾有問題,或者請求method不對。

下面說一下在書寫上幾個需要注意的點。

1.對於無參方法(一般是後端呼叫的inner方法),一般不會出錯。

2.首先區分get請求還是post請求

還要加上這個值 paramtype = "body"。  

注意在controller層中也要加,@requestparam 不用在controller中加了。

3.對於list<>列表型入參,也需要用 @requestbody註解修飾,datatype一般是string

在引數前面加@requestparam(),其實get請求加@requestbody還是@requestparam()都行。

5.最後要在controller和service層impl裡加上對應的註解

@restcontroller和  @service

Swagger的使用及註解說明

一 使用方法 在pom.xml中加入swagger2的依賴 io.springfox springfox swagger2 2.7.0 io.springfox springfox swagger ui 2.7.0 建立swagger2配置類 configuration enableswagger2...

swagger註解的使用

apiimplicitparams 5.apiresponses 用於表示一組響應 6.apiresponse 用在 apiresponses中,一般用於表達乙個錯誤的響應資訊 code 數字,例如400 message 資訊,例如 請求引數沒填好 response 丟擲異常的類 apirespon...

swagger註解的使用

前面有介紹過swagger的專案整合步驟,但是沒有確切的註解使用內容。下面我就對swagger使用註解進行一些比較細化的記錄,如果漏了啥,可以在提醒我。下面直接進入主題。api 說明 用於controller層類註解,引數有value和tags。都是說明的意思。註解寫在類上 apioperation...