Swagger的入門和常用註解

}@api(value="xx",tags="2xx"), value是當前controller的描述, tags也可以作為描述, 也可以把controller分為幾組.

@api(tags = )

@controller
效果:
等同於告訴swagger這個方法的作用描述
效果同上圖的方法描述
name 引數名稱
value 引數描述
required 是否必填
datatype 引數資料型別
paramtype 引數型別
@apioperation("獲取使用者詳細")
@apiimplicitparam(name = "userid", value = "使用者id", required = true, datatype = "int", paramtype = "path")
public
ajaxresult getuser(@pathvariable integer userid) 
else
}

name 這個引數名稱是什麼, 一般不填寫. 預設就是引數名稱

value 請求引數的描述資訊

required 請求引數為必填項

apimodel 表示對類作為說明,用於引數為實體類接收.

apimodeproperty 用於物件的方法欄位的描述.

name 表示欄位名,一般不寫

value 表示欄位的說明

required 請求引數為必填項

hidden 表示字段是否隱藏

@apimodel("使用者實體")

class
userentity {
@apimodelproperty("使用者id")
private
integer userid;
@apimodelproperty("使用者名稱")
private
string username;
@apimodelproperty("使用者密碼")
private
string password;
@apimodelproperty("使用者手機")
private string mobile;

暫時先記錄這麼多, 之後用到別的再新增.

swagger常用註解

一 swagger常用註解 1 與模型相關的註解 兩個註解 2 與介面相關的註解 六個註解 二 幾個注意點 為了在swagger ui上看到輸出，至少需要兩個註解 api和 apioperation 即使只有乙個 apiresponse，也需要使用 apiresponses包住 對於 apiimpl...

swagger常用註解

一 swagger常用註解 1 與模型相關的註解 兩個註解 2 與介面相關的註解 六個註解 二 幾個注意點 為了在swagger ui上看到輸出，至少需要兩個註解 api和 apioperation 即使只有乙個 apiresponse，也需要使用 apiresponses包住 對於 apiimpl...

swagger常用註解

swagger2常用註解說明 2017年08月01日 14 00 38 說明 1.這裡使用的版本 springfox swagger2 2.4 springfox swagger ui 2.4 2.這裡是說明常用註解的含義和基本用法 也就是說已經對swagger進行整合完成 沒有整合的請參見 spr...