swagger 架構介紹

2021-09-24 19:49:06 字數 1265 閱讀 3882

swagger是當前最好用的restful api文件生成的開源專案,通過swagger-spring專案,實現了與spingmvc框架的無縫整合功能,方便生成spring restful風格的介面文件

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

tags="說明該類的作用,可以在ui介面上看到的註解"

value="該引數沒什麼意義,在ui介面上也看到,所以不需要配置"

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

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

notes="方法的備註說明"

httpmethod = 「介面請求方式」

response = 「介面返回引數型別」

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

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

name:引數名

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

required:引數是否必須傳

paramtype:引數放在哪個地方

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

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

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

· body(不常用)

· form(不常用)

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

defaultvalue:引數的預設值

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

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

code:數字,例如400

message:資訊,例如"請求引數沒填好"

response:丟擲異常的類

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

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

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

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

@apiparam(required = 「是否必須引數」, name = 「引數名稱」, value = 「引數具體描述」)

Swagger的介紹與使用

swagger是乙個規範和完整的框架,用於生成 描述 呼叫和視覺化restful風格的web服務。作用 功能測試。io.springfoxgroupid springfox swagger2artifactid 2.6.1version dependency io.springfoxgroupid ...

mysql架構介紹 Mysql邏輯架構介紹

總體概覽 和其它資料庫相比,mysql有點與眾不同,它的架構可以在多種不同場景中應用並發揮良好作用。主要體現在儲存引擎的架構上,外掛程式式的儲存引擎架構將查詢處理和其它的系統任務以及資料的儲存提取相分離。這種架構可以根據業務的需求和實際需要選擇合適的儲存引擎。1.連線層 最上層是一些客戶端和連線服務...

XML 架構介紹

xml 架構介紹 xml 架構是用於定義和驗證 xml 資料的內容和結構的文件,就像資料庫架構定義和驗證組成資料庫的表 列和資料型別一樣。xml 架構通過 xml 架構定義 xsd 語言定義和描述某些 xml 資料型別。xml 架構元素 元素 屬性 型別和組 用於定義某些 xml 資料型別的有效結構...