swagger2 註解說明

4、`@apiresponses`、`@apiresponse`：方法返回值的說明

5、`@apimodel`、`@apimodelproperty`：用於響應類上，表示乙個返回響應資料的資訊

用於controller類上

註解說明

@api

協議集描述

方法上註解

說明@apioperation

-@apiimplicitparams

方法上@apiimplicitparam

用在@apiimplicitparams的方法裡邊

@apiresponses

方法上@apiresponse

用在 @apiresponses裡邊

返回物件類

註解說明

@apimodel

用在返回物件類上

@apimodelproperty

用在出入引數物件的字段上

@api：放在 請求的類上，與@controller並列，說明的請求類的用下，如使用者登入類，訂單類等。

tags=
"說明該類的作用"
value=
"該引數沒什麼意義，所以不需要配置"

@api

(tags=
)@controller
public
class
apilogincontroller
@api
屬性配置：
與controller註解並列使用。
屬性名稱
備註value
url的路徑值
br#description
對api資源的描述
basepath
基本路徑
position
如果配置多個api 想改變顯示的順序位置
produces
consumes
protocols
協議型別，如: http, https, ws, wss.
authorizations
高階特性認證時配置
hidden
配置為true ，將在文件中隱藏
@apioperation："用在請求的方法上，說明方法的作用"
value=
"說明方法的作用"
notes=
"方法的備註說明"

@apiimplicitparams：用在請求的方法上，包含一組引數說明

@apiimplicitparam：對單個引數的說明	    
name：引數名
value：引數的漢字說明、解釋
required：引數是否必須傳
paramtype：引數放在哪個地方
· header --
> 請求引數的獲取：@requestheader
· query --
> 請求引數的獲取：@requestparam
· path（用於restful介面）--
> 請求引數的獲取：@pathvariable
· body（請求體）--
>
@requestbody user user
· form（不常用）	   
datatype：引數型別，預設string，其它值datatype=
"integer"	   
defaultvalue：引數的預設值

@apioperation

(value=
"使用者登入"
,notes=
"手機號、密碼都是必輸項，年齡隨邊填，但必須是數字"
)@apiimplicitparams()
("/login"
)public jsonresult login
(@requestparam string mobile,
@requestparam string password,
@requestparam integer age)

@apiresponses：方法返回物件的說明

@apiresponse：每個引數的說明
code：數字，例如400
message：資訊，例如"請求引數沒填好"
response：丟擲異常的類

@apioperation

("獲取使用者資訊"
)@apiimplicitparams()
@apiresponses()
@responsebody
("/list"
)public jsonresult list
(@requestparam string userid)

@apimodel：用於響應類上，表示乙個返回響應資料的資訊

（這種一般用在post建立的時候，使用@requestbody這樣的場景，
請求引數無法使用 @apiimplicitparam 註解進行描述的時候）
@apimodelproperty：用在屬性上，描述響應類的屬性

@apimodel

(description=
"返回響應資料"
4、`@apiresponses`、`@apiresponse`：方法返回值的說明
5、`@apimodel`、`@apimodelproperty`：用於響應類上，表示乙個返回響應資料的資訊
用於controller類上
				
swagger2註解說明
apioperation 用在請求的方法上，說明方法的用途 作用 value 說明方法的用途 作用 notes 方法的備註說明 use case apioperation value 使用者註冊 notes 手機號 密碼都是必輸項，年齡隨邊填，但必須是數字 apiimplicitparams 用在請...
				
swagger2註解說明
api 用在請求的類上，表示對類的說明 tags 說明該類的作用，可以在ui介面上看到的註解 value 該引數沒什麼意義，在ui介面上也看到，所以不需要配置 apioperation 用在請求的方法上，說明方法的用途 作用 value 說明方法的用途 作用 notes 方法的備註說明 api 用在...
				
swagger2 註解說明
用於controller類上 註解說明 api 協議集描述 方法上註解 說明 apioperation apiimplicitparams 方法上 apiimplicitparam 用在 apiimplicitparams的方法裡邊 apiresponses 方法上 apiresponse 用在 a...