swagger是當前最好用的restful api文件生成的開源專案,通過swagger-spring專案實現了springmvc框架的無縫整合功能,方便生成restful風格的介面文件,
同時,swagger-ui還可以測試spring restful風格的介面功能
作用範圍 api 使用位置
物件屬性 @apimodelproperty 用在引數物件的字段上
協議集描述 @api 用在conntroller類上
協議描述 @apioperation 用在controller方法上
response集 @apiresponses 用在controller方法上
response @apiresponse 用在@apiresponses裡面
非物件引數集 @apilmplicitparams 用在controller方法上
非物件引數描述
@apiimplicitparam
用在@apiimplicitparams的方法裡邊
描述返回物件的意義
@apimodel
用在返回物件類上
value–字段說明
name–重寫屬性名字
datatype–重寫屬性型別
required–是否必填
example–舉例說明
hidden–隱藏
// 我這個用在實體類的get()方法上了value - 字段說明/*** 獲取城市編號
* @return 城市編號
*/@apimodelproperty(value="城市編號",example="058",required=true)
public string getcode()
/*** 設定城市編號
* @param code 城市編號
*/public void setcode(string code)
/*** 獲取城市名稱
* @return 城市名稱
*/@apimodelproperty(value="城市名稱",example="guangzhou",required=true)
public string getname()
description - 注釋說明這個類
value - 字段說明
notes - 注釋說明
httpmethod - 說明這個方法被請求的方式
response - 方法的返回值的型別
code - 響應的http狀態碼
message - 響應的資訊內容
swagger注釋API詳細說明
注釋彙總 作用範圍 api使用位置 物件屬性 apimodelproperty 用在出入引數物件的字段上 協議集描述 api 用於controller類上 協議描述 apioperation 用在controller的方法上 response集 apiresponses 用在controller的方...
swagger注釋API詳細說明
注釋彙總 作用範圍 api使用位置 物件屬性 apimodelproperty 用在出入引數物件的字段上 協議集描述 api 用於controller類上 協議描述 apioperation 用在controller的方法上 response集 apiresponses 用在controller的方...
swagger注釋API詳細說明
注釋彙總 作用範圍 api使用位置 物件屬性 apimodelproperty 用在出入引數物件的字段上 協議集描述 api 用於controller類上 協議描述 apioperation 用在controller的方法上 response集 apiresponses 用在controller的方...