1. @api
用在類上，說明該類的作用
@api(value = "usercontroller", description = "使用者相關api")
2. @apioperation
用在方法上，說明方法的作用
3 @apiimplicitparams
用在方法上包含一組引數說明
4. @apiimplicitparam
用在@apiimplicitparams註解中，指定乙個請求引數的各個方面
paramtype：引數放在哪個地方
header–>請求引數的獲取：@requestheader
query–>請求引數的獲取：@requestparam
path（用於restful介面）–>請求引數的獲取：@pathvariable
body（不常用）
form（不常用）
name：引數名
datatype：引數型別
required：引數是否必須傳
value：引數的意思
defaultvalue：引數的預設值
@apiimplicitparams()
5. @apiresponses
用於表示一組響應
6. @apiresponse
用在@apiresponses中，一般用於表達乙個錯誤的響應資訊
code：數字，例如400
message：資訊，例如」請求引數沒填好」
response：丟擲異常的類
@apiresponses(value ={
@apiresponse(code= 400, message = "no name provided")
7. @apimodel
描述乙個model的資訊（這種一般用在post建立的時候，使用@requestbody這樣的場景，請求引數無法使用@apiimplicitparam註解進行描述的時候）
@apimodel(value = "使用者實體類")
8. @apimodelproperty
描述乙個model的屬性
@apimodelproperty(value = "登入使用者")
最常用的5個註解
@api：修飾整個類，描述controller的作用
@apioperation：描述乙個類的乙個方法，或者說乙個介面
@apiparam：單個引數描述
@apimodel：用物件來接收引數
@apiproperty：用物件接收引數時，描述物件的乙個字段
其它若干
@apiresponse：http響應其中1個描述
@apiresponses：http響應整體描述
@apiignore：使用該註解忽略這個api
@apiclass
@apierror@apierrors
@apiparamimplicit@apiparamsimplicit
歡迎交流:[email protected]
github:
swagger註解說明
前言 使用swagger的主要好處就是不用手動寫文件了，通過註解就可以自動化文件。文件和 同步更新，更新之後不需要再更新文件。使用swagger框架可以除錯api，在瀏覽器端可以看到更多的 request 和 response 資訊。本文章重點描述下swagger應用注釋說明。示例 首先是 cmsc...
Swagger註解說明
常用註解 api 用於類 表示標識這個類是swagger的資源 apioperation 用於方法 表示乙個http請求的操作 apiparam 用於方法，引數，字段說明 表示對引數的新增元資料 說明或是否必填等 apimodel 用於類 表示對類進行說明，用於引數用實體類接收 apimodelpr...
swagger註解說明 swagger常用註解說明
常用到的註解有 apiapimodel apimodelproperty apioperation apiparam apiresponse apiresponses responseheader 1.api標記 api 用在類上，說明該類的作用。可以標記乙個controller類做為swagger...