Swagger2常用註解說明

2022-03-22 01:36:56 字數 1185 閱讀 9507

這裡只講述@api、@apioperation、@apiimplicitparams、@apiimplicitparam、@apiparam、@apimodel、@apimodelproperty、apiresponses、@apiresponse這幾個常用的。
@api:用在請求的類上,表示對類的說明

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

@apimodelproperty:用在屬性上,描述響應類的屬性

示例:@apimodel(value="使用者登入資訊", description="用於判斷使用者是否存在")

public class usermodel implements serializable

其他(@apimodelproperty):

value 此屬性的簡要說明。

name 允許覆蓋屬性名稱

allowablevalues 限制引數的可接受值。1.以逗號分隔的列表 2、範圍值 3、設定最小值/最大值

access 允許從api文件中過濾屬性。

notes 目前尚未使用。

datatype 引數的資料型別。可以是類名或者引數名,會覆蓋類的屬性名稱。

required 引數是否必傳,預設為false

position 允許在類中對屬性進行排序。預設為0

hidden 允許在swagger模型定義中隱藏該屬性。

example 屬性的示例。

readonly 將屬性設定為唯讀。

reference 指定對相應型別定義的引用,覆蓋指定的任何引數值

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

@apiresponse:用在@apiresponses中,一般用於表達乙個錯誤的響應資訊愛吃醋的兔子

swagger2常用註解說明

說明 1.這裡使用的版本 springfox swagger2 2.4 springfox swagger ui 2.4 2.這裡是說明常用註解的含義和基本用法 也就是說已經對swagger進行整合完成 沒有整合的請參見 springboot整合springfox swagger2構建restful...

swagger2常用註解說明

引入swagger的版本測試為 io.springfox springfox swagger2 2.2.2 api 用於類 可選值 value,tags,description.可以自行檢視原始碼 片段 效果圖 用於方法 表示乙個http請求的操作 value用於方法描述 notes用於提示內容 a...

swagger2常用註解說明

原文 說明 1.這裡使用的版本 springfox swagger2 2.4 springfox swagger ui 2.4 2.這裡是說明常用註解的含義和基本用法 也就是說已經對swagger進行整合完成 沒有整合的請參見 springboot整合springfox swagger2構建rest...