swagger2相關註解

2021-09-26 10:13:20 字數 483 閱讀 8682

@api: 描述 controller

@apiignore: 忽略該 controller,指不對當前類做掃瞄

@apioperation: 描述 controller類中的 method介面

@apiparam: 單個引數描述,與 @apiimplicitparam不同的是,他是寫在引數左側的。如( @apiparam(name="username",value="使用者名稱")stringusername)

@apimodel: 描述 pojo物件

@apiproperty: 描述 pojo物件中的屬性值

@apiimplicitparam: 描述單個入參資訊

@apiimplicitparams: 描述多個入參資訊

@apiresponse: 描述單個出參資訊

@apiresponses: 描述多個出參資訊

@apierror: 介面錯誤所返回的資訊

swagger2 註解說明

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

swagger2註解說明

apioperation 用在請求的方法上,說明方法的用途 作用 value 說明方法的用途 作用 notes 方法的備註說明 use case apioperation value 使用者註冊 notes 手機號 密碼都是必輸項,年齡隨邊填,但必須是數字 apiimplicitparams 用在請...

swagger2註解說明

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