swagger註解的使用

2021-08-11 14:08:22 字數 493 閱讀 5521

@apiimplicitparams()

5. @apiresponses

用於表示一組響應

6. @apiresponse

用在@apiresponses中,一般用於表達乙個錯誤的響應資訊

code:數字,例如400

message:資訊,例如」請求引數沒填好」

response:丟擲異常的類

@apiresponses(value =)

7. @apimodel

描述乙個model的資訊(這種一般用在post建立的時候,使用@requestbody這樣的場景,請求引數無法使用@apiimplicitparam註解進行描述的時候)

@apimodel(value = "使用者實體類")

8. @apimodelproperty

描述乙個model的屬性

@apimodelproperty(value = "登入使用者")

Swagger 註解使用

首先我們通過swagger的原始碼可以看到有很多的註解,下面這張截圖應該可以包括swagger的所有註解。註解名稱 使用說明 api api 用在類上,說明該類的作用。可以標記乙個 controller 類作為 swagger 文件資源,所以一般用在controller介面中,在swagger頁面上...

swagger註解的使用

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

swagger文件註解使用

效果圖 controller註解 這裡給引數新增註解,我傾向於使用下面這種 apiimplicitparams public zingresult selectallusers integer page,integer size 而不是這種 public zingresult selectone a...