Swagger2常用註解說明

2021-09-16 20:43:24 字數 2931 閱讀 1288

@api:用在請求的類上,表示對類的說明:
常用引數:

tags="說明該類的作用,非空時將覆蓋value的值"

value="描述類的作用"

其他引數:

description 對api資源的描述,在1.5版本後不再支援

basepath 基本路徑可以不配置,在1.5版本後不再支援

position 如果配置多個api 想改變顯示的順序位置,在1.5版本後不再支援

protocols 設定特定協議,例:http, https, ws, wss。

authorizations 獲取授權列表(安全宣告),如果未設定,則返回乙個空的授權值。

hidden 預設為false, 配置為true 將在文件中隱藏

@apioperation:用在請求的方法上,說明方法的用途、作用常用引數:

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

notes="方法的備註說明"

其他引數:

tags 操作標籤,非空時將覆蓋value的值

response 響應型別(即返回物件)

responsecontainer 宣告包裝的響應容器(返回物件型別)。有效值為 "list", "set" or "map"。

responsereference 指定對響應型別的引用。將覆蓋任何指定的response()類

httpmethod 指定http方法,"get", "head", "post", "put", "delete", "options" and "patch"

position 如果配置多個api 想改變顯示的順序位置,在1.5版本後不再支援

nickname 第三方工具唯一標識,預設為空

protocols 設定特定協議,例:http, https, ws, wss。

authorizations 獲取授權列表(安全宣告),如果未設定,則返回乙個空的授權值。

hidden 預設為false, 配置為true 將在文件中隱藏

responseheaders 響應頭列表

code 響應的http狀態**。預設 200

extensions 擴充套件屬性列表陣列

@apiimplicitparams:用在請求的方法上,表示一組引數說明@apiimplicitparam:用在@apiimplicitparams註解中,指定乙個請求引數的各個方面name:引數名,引數名稱可以覆蓋方法引數名稱,路徑引數必須與方法引數一致

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

required:引數是否必須傳,預設為false [路徑引數必填]

paramtype:引數放在哪個地方

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

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

· path(用於restful介面)--> 請求引數的獲取:@pathvariable

· body(不常用)

· form(不常用)

datatype:引數型別,預設string,其它值datatype="integer"

defaultvalue:引數的預設值

@apimodel:用於響應類上,表示乙個返回響應資料的資訊(這種一般用在post建立的時候,使用@requestbody這樣的場景,請求引數無法使用@apiimplicitparam註解進行描述的時候)@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 指定對相應型別定義的引用,覆蓋指定的任何引數值

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...