Swagger 註解使用

首先我們通過swagger的原始碼可以看到有很多的註解，下面這張截圖應該可以包括swagger的所有註解。

註解名稱

使用說明

@api

@api 用在類上，說明該類的作用。可以標記乙個 controller 類作為 swagger 文件資源,所以一般用在controller介面中，在swagger頁面上說明這個介面文件

@apimodel

使用在實體類上， 一般用來對介面入參來說明

@api  使用

1.  使用@api 的**示例

@restcontroller

@api(tags = "密保問題")
public class ***xcontroller extends basecontroller 
@restcontroller
@api(tags = "認識我們")
public class ***xcontroller extends basecontroller 
@restcontroller
@api(tags = "設定密碼")
public class ***xcontroller extends basecontroller 

@apimodel 使用1. **示例

@apimodel("設定密碼引數")

public class ***param 

使用說名

常用引數

@apimodelproperty

@apimodelproperty()和@apimodel 配套使用在實體類中， 用於字段，表示對 model 屬性的說明

value–字段說明 

name–重寫屬性名字 

datatype–重寫屬性型別 

required–是否必填 

example–舉例說明 

hidden–隱藏

@apiimplicitparam 和 @apiimplicitparams

api配套使用在controller介面的方法上，對單獨的引數進行說明 

這兩個註解一起使用，當只有乙個引數修飾用@apiimplicitparam，當有多個參引數用@apiimplicitparams

@apiparam

@apiparam 用於 controller 中方法的引數說明。使用方式**如下所示。

@apimodelproperty  **使用

@data

@apimodel( description = "新增使用者引數")
public class adduserparam 

@apiimplicitparams()

public userdto getuser(@requestparam("id") string id) 

public userdto adduser(@apiparam(value = "新增使用者引數", required = true) @requestbody adduserparam param)

註解使用

@apioperation

@apioperation 用在 controller 裡的方法上，說明方法的作用，每乙個介面的定義。

@apioperation **示例

@apioperation(value="新增使用者", notes="詳細描述")

public userdto adduser(@apiparam(value = "新增使用者引數", required = true) @requestbody adduserparam param) 

swagger註解的使用

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

swagger文件註解使用

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

swagger註解的使用

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