註解
屬性說明
@api
用於類上，說明該類的作用。可以標記乙個controller類作為swagger的文件資源
value
url的路徑
br#description
對api資源的描述
basepath
基本路徑，可以不用配置
position
設定多個api顯示的順序位置
高階特性認證時配置
hidden
配置為true 將在文件中隱藏
@apioperation
用於方法上，說明方法的作用，每乙個url資源的定義
value
url的路徑
br#notes
對api資源的描述
position
設定多個api顯示的順序位置
高階特性認證時配置
hidden
配置為true 將在文件中隱藏
response
返回的物件
responsecontainer
包含的這些物件是有效的 「list」，「set」，「map」，其他無效
http的狀態碼，預設200
extensions
擴充套件屬性
@apiparam
用於方法、引數、欄位上，表示請求屬性
name
屬性名稱
value
屬性值defaultvalue
預設屬性值
allowablevalues
可以不用配置
required
該屬性是否必填
access
allowmultiple
預設為false
hidden
是否隱藏該屬性
example
示例@apiresponse
用於方法上，響應配置
code
http狀態碼
message
描述response
預設響應類void
reference
responseheaders
參考下方responseheader的配置
responsecontainer
包含的這些物件是有效的 「list」，「set」，「map」，其他無效
@apiresponses
用於方法上，響應集配置
value
多個apiresponse配置
@responseheader
用於方法上，響應頭設定
name
響應頭名稱
description
頭部描述
response
預設響應類void
responsecontainer
參考apioperation中配置
@apiimplicitparams
用於方法上，包含一組引數說明
@apiimplicitparam
用於方法上，用在@apiimplicitparams 註解中，指定乙個請求引數的各個方面
paramtype
引數放在哪個地方。
· header 引數在request headers 裡邊提交（@requestheader）；
· query 直接跟引數完成自動對映賦值（@requestparam）；
· path 用於restful介面，以位址的形式提交資料（@pathvariable）；
· body 以流的形式提交 僅支援post（@requestbody）；
· form 以form表單的形式提交 僅支援post
name
引數名value
引數的漢字說明，解釋
datatype
引數型別，預設string，其他值datatype=「integer」，無用
required
是否必填
defaultvalue
引數的預設值
@apimodel
用於類上，描述乙個model的資訊 （這種一般用在post建立的時候，使用@requestbody這樣的場景，請求引數無法使用@apiimplicitparam註解進行描述的時候）
@apimodelproperty
用於方法、欄位上，描述乙個model的屬性
@apilgnore
用於類、屬性、方法上，忽略某項api，使用@apiignore
swagger配置及使用
swagger2 註解說明
4 apiresponses apiresponse 方法返回值的說明 5 apimodel apimodelproperty 用於響應類上，表示乙個返回響應資料的資訊 用於controller類上 註解說明 api 協議集描述 方法上註解 說明 apioperation apiimplicitpa...
swagger2註解說明
apioperation 用在請求的方法上，說明方法的用途 作用 value 說明方法的用途 作用 notes 方法的備註說明 use case apioperation value 使用者註冊 notes 手機號 密碼都是必輸項，年齡隨邊填，但必須是數字 apiimplicitparams 用在請...
swagger2註解說明
api 用在請求的類上，表示對類的說明 tags 說明該類的作用，可以在ui介面上看到的註解 value 該引數沒什麼意義，在ui介面上也看到，所以不需要配置 apioperation 用在請求的方法上，說明方法的用途 作用 value 說明方法的用途 作用 notes 方法的備註說明 api 用在...