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

2021-10-02 03:11:02 字數 1094 閱讀 6862

什麼是swagger?

swagger是乙個用於快速生成開發文件的工具,它能夠跟著**的變更而同步更新開發文件。

為什麼需要swagger?

在開發中需求是會經常變化的,需求快速的變更使得我們不得不同步更新相應的各種文件,而這無形之中增加了日常的工作量,而swagger呢能夠自動生成開發文件,並且會自動更新相關文件資訊!

開始使用swagger

匯入swagger相關依賴

>

>

io.springfoxgroupid

>

>

springfox-swagger2artifactid

>

>

2.9.2version

>

dependency

>

>

>

io.springfoxgroupid

>

>

springfox-swagger-uiartifactid

>

>

2.9.2version

>

dependency

>

在springboot主類main中新增@enableswagger2註解

@enableasync

@enablediscoveryclient

@enableswagger2

//引入swagger

public

class

啟動專案,訪問/swagger-ui.html路徑

選擇自己需要的api文件集

可以看到裡邊包含了我們在處理器裡邊定義的所有介面,並且有介面的詳細資訊(所需請求引數、大致返回結果、相關狀態碼、可支援的訪問方法)

Web開發 使用Swagger

這個解釋簡單點來講就是說,swagger是一款可以根據resutful風格生成的生成的介面開發文件,並且支援做測試的一款中間軟體。2.1 對於後端開發人員來說 不用再手寫wiki介面拼大量的引數,避免手寫錯誤 對 侵入性低,採用全註解的方式,開發簡單 方法引數名修改 增加 減少引數都可以直接生效,不...

swagger 快速入門

貴在堅持 難在堅持 成在堅持。故事還是要從前後端分離講起啊 前後端分離 vue springboot 基本上都用這一套 後端時代 前端只用管理靜態頁面,html 後端,使用模版引擎 jsp 後端主力 前後端分離時代 前後端如何互動 api 前後端相對獨立,松耦合 前後端甚至可以部署在不同的伺服器上 ...

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