Web開發 使用Swagger

2021-10-23 19:07:19 字數 1274 閱讀 6409

這個解釋簡單點來講就是說,swagger是一款可以根據resutful風格生成的生成的介面開發文件,並且支援做測試的一款中間軟體。

2.1:對於後端開發人員來說

不用再手寫wiki介面拼大量的引數,避免手寫錯誤

對**侵入性低,採用全註解的方式,開發簡單

方法引數名修改、增加、減少引數都可以直接生效,不用手動維護

缺點:增加了開發成本,寫介面還得再寫一套引數配置

2.2:對於前端開發來說

後端只需要定義好介面,會自動生成文件,介面功能、引數一目了然

聯調方便,如果出問題,直接測試介面,實時檢查引數和返回值,就可以快速定位是前端還是後端的問題

2.3:對於測試

對於某些沒有前端介面ui的功能,可以用它來測試介面

操作簡單,不用了解具體**就可以操作

操作簡單,不用了解具體**就可以操作

swagger

@api:修飾整個類,描述controller的作用 

@apioperation:描述乙個類的乙個方法,或者說乙個介面

@apiparam:單個引數描述

@apimodel:用物件來接收引數

@apimodelproperty:用物件接收引數時,描述物件的乙個字段

@apiresponse:http響應其中1個描述

@apiresponses:http響應整體描述

@apiignore:使用 該註解忽略這個api

@apierror :發生錯誤返回的資訊

@apiimplicitparam:乙個請求引數

@apiimplicitparams:多個請求引數

@apiimplicitparam屬性:

paramtype 查詢引數型別

path 以位址的形式提交資料

query 直接跟引數完成自動對映賦值

body 以流的形式提交 僅支援post

header 引數在request headers 裡邊提交

form 以form表單的形式提交 僅支援post

datatype 引數的資料型別 只作為標誌說明,並沒有實際驗證 long string

name 接收引數名

value 接收引數的意義描述

required 引數是否必填 true 必填 false 非必填

defaultvalue 預設值

使用swagger編寫開發介面文件

1.在pom.xml中匯入依賴 io.springfox springfox swagger2 2.9.2 io.springfox springfox swagger ui 2.9.2 2.在controller類中加註解 1.在類名上新增註解 api tags 生成驗證碼 enableswagg...

開發技巧 使用Swagger快速生成開發文件

什麼是swagger?swagger是乙個用於快速生成開發文件的工具,它能夠跟著 的變更而同步更新開發文件。為什麼需要swagger?在開發中需求是會經常變化的,需求快速的變更使得我們不得不同步更新相應的各種文件,而這無形之中增加了日常的工作量,而swagger呢能夠自動生成開發文件,並且會自動更新...

swagger使用詳解

swagger 的目標是為rest apis 定義乙個標準的,與語言無關的介面,使人和計算機在看不到原始碼或者看不到文件或者不能通過網路流量檢測的情況下能發現和理解各種服務的功能。當服務通過swagger定義,消費者就能與遠端的服務互動通過少量的實現邏輯。類似於低階程式設計介面,swagger去掉了...