springboot之swagger快速啟動(新的ui)
功能點:
- 集成
swagger
前端接口文檔 Swagger
整合zuul
智能列表- 無縫集成
knife4j
前端文檔 支持v0.1.2RELEASE
zuul
智能列表
簡介
在原有 swagger
功能之上集成 knife4j
。
knife4j
是 springfox-swagger
的增強UI實現,為Java開發者在使用Swagger的時候,能擁有一份簡潔、強大的接口文檔體驗。
該UI增強包主要包括兩大核心功能:文檔說明 和 在線調試
文檔說明: 根據Swagger的規范說明,詳細列出接口文檔的說明,包括接口地址、類型、請求示例、請求參數、響應示例、響應參數、響應碼等信息,使用swagger-bootstrap-ui能根據該文檔說明,對該接口的使用情況一目了然。
在線調試: 提供在線接口聯調的強大功能,自動解析當前接口參數,同時包含表單驗證,調用參數可返回接口響應內容、headers、Curl請求命令實例、響應時間、響應狀態碼等信息,幫助開發者在線調試,而不必通過其他測試工具測試接口是否正確,簡介、強大。
功能使用
添加依賴
<dependency>
<groupId>io.deepblueai</groupId>
<artifactId>swagger-deepblueai-starter</artifactId>
<version>0.2.0.RELEASE</version>
</dependency>
UI訪問
訪問地址: http://ip:端口/doc.html
可以訪問基本ok。
全局token
新增 Authorize
全局 token
默認參數設置為了 Authorization
儲存在 header
, 如和自己的參數不一致請在 通用參數配置
設置。
通用參數配置
通用參數配置是一個比較常用的功能,如 攜帶 token
訪問接口。
和 postman
功能類似,解決 swagger
缺陷。
開啟功能
路徑: 文檔管理/個性化設置
- 啟用Knife4j提供的增強功能
- 開啟動態請求參數
添加參數
路徑: 文檔管理/全局參數設置
添加 oauth2 token
值已自己登陸token 前綴記得添加 Bearer
。
參數名稱: Authorization
參數值: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE1ODI4MjYyNTIsInVzZXJfbmFtZSI6ImFkbWluIiwiYXV0aG9yaXRpZXMiOlsiUk9MRV9KSUFPU0UxIiwiUk9MRV9NRU1CRVJTIl0sImp0aSI6IjA3YWZjMDVhLWU3NjYtNDMxOC1iZGRmLWJkMWU4NTExOWU5MiIsImNsaWVudF9pZCI6InNzby1hdXRoLXNlcnZlciIsInNjb3BlIjpbInNlcnZlciJdfQ.LFMcZTXb0g4xTzRo8kVAwBbXe12-XRsYWJkHFBRCbWg
訪問接口
需要登陸的接口 在請求頭里會默認都添加有 Authorization
。
離線文檔
Knife4j提供導出4種格式的離線文檔(Html\Markdown\Word\Pdf)
路徑: 文檔管理/離線文檔
示例代碼地址:swagger-spring-boot
總結
沒有特別的代碼,只有好用的功能,歡迎關注。
作者GitHub:
Purgeyao 歡迎關注
qq交流群:
812321371
微信交流群:MercyYao
微信公眾號: