swagger2註解說明

@apioperation：用在請求的方法上，說明方法的用途、作用

value="說明方法的用途、作用"

notes="方法的備註說明"

use case:@apioperation(value="使用者註冊",notes="手機號、密碼都是必輸項，年齡隨邊填，但必須是數字")

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

@apiimplicitparam：用在@apiimplicitparams註解中，指定乙個請求引數的各個方面

name：引數名

value：引數的漢字說明、解釋

required：引數是否必須傳

paramtype：引數放在哪個地方

· header --> 請求引數的獲取：@requestheader

· query --> 請求引數的獲取：@requestparam

· path（用於restful介面）--> 請求引數的獲取：@pathvariable

· body（不常用）

· form（不常用）    

datatype：引數型別，預設string，其它值datatype="integer"       

defaultvalue：引數的預設值

use case:@apiimplicitparams()

@apiresponses：用在請求的方法上，表示一組響應

@apiresponse：用在@apiresponses中，一般用於表達乙個錯誤的響應資訊

code：數字，例如400

message：資訊，例如"請求引數沒填好"

response：丟擲異常的類

use case:@apioperation(value = "select1請求",notes = "多個引數，多種的查詢引數型別")

@apiresponses()

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

（這種一般用在post建立的時候，使用@requestbody這樣的場景，

請求引數無法使用@apiimplicitparam註解進行描述的時候）

@apimodelproperty：用在屬性上，描述響應類的屬性

use case:@apimodel

public class userrolevo extends pagerequest implements serializable

swagger2 註解說明

4 apiresponses apiresponse 方法返回值的說明 5 apimodel apimodelproperty 用於響應類上，表示乙個返回響應資料的資訊 用於controller類上 註解說明 api 協議集描述 方法上註解 說明 apioperation apiimplicitpa...

swagger2註解說明

api 用在請求的類上，表示對類的說明 tags 說明該類的作用，可以在ui介面上看到的註解 value 該引數沒什麼意義，在ui介面上也看到，所以不需要配置 apioperation 用在請求的方法上，說明方法的用途 作用 value 說明方法的用途 作用 notes 方法的備註說明 api 用在...

swagger2 註解說明

用於controller類上 註解說明 api 協議集描述 方法上註解 說明 apioperation apiimplicitparams 方法上 apiimplicitparam 用在 apiimplicitparams的方法裡邊 apiresponses 方法上 apiresponse 用在 a...