yapi 插件_精神多了，当Swagger遇上YApi，瞬间高大上了！
YApi簡介
YApi是高效、易用、功能強大的API管理平臺，旨在為開發、產品、測試人員提供更優雅的接口管理服務。YApi在Github上已累計獲得了18K+Star，具有優秀的交互體驗，YApi不僅提供了常用的接口管理功能，還提供了權限管理、Mock數據、Swagger數據導入等功能，總之功能很強大！
安裝
環境準備
本地部署YApi需要先安裝nodejs和MongoDB，我們先把它們安裝好。
安裝nodejs，直接下載安裝包雙擊安裝即可，這里安裝的是12.14.0版本，下載地址：https://nodejs.org/dist/v12.14.0/node-v12.14.0-x64.msi;
安裝MongoDB，參考《MongoDB快速入門，掌握這些剛剛好！》中的安裝即可，這里安裝的是4.2.5版本。
安裝yapi-cli
yapi-cli是YApi官方提供的安裝工具，可以通過可視化界面來部署YApi服務，非常方便！
- 使用npm命令來安裝yapi-cli：
- 安裝成功后控制臺輸出如下內容；
- 安裝成功后使用yapi server命令來啟動YApi的可視化部署界面。
安裝YApi
- 通過可視化部署界面安裝YApi服務，訪問地址：http://localhost:9090
- 安裝完成后會輸出如下信息，提示YApi的默認管理員賬號密碼及訪問地址；
- 進入YApi的安裝目錄，使用node命令啟動YApi服務：
- 啟動成功后控制臺輸出信息如下；
- 通過頁面訪問Yapi，默認賬號密碼為admin@admin.com:ymfe.org，訪問地址：http://localhost:3000
使用
從Swagger導入數據
- 使用管理員賬號登錄成功后，先創建一個mall-tiny-group分組；
- 創建分組成功后，在該分組下點擊創建項目，添加mall-tiny-swagger項目；
- 之后啟動我們之前的mall-tiny-swagger項目，啟動成功后Swagger接口文檔訪問地址：http://localhost:8088/swagger-ui/
- 選擇好YApi的數據管理功能，配置好Swagger的api-docs路徑，然后進行數據導入；
- 至此Swagger中的API接口已成功導入到YApi，點擊接口標簽查看所有導入接口。
接口管理
- 打開添加商品的接口看看，可以看到非常完善的接口文檔信息，注釋都有了；
- 來試試接口運行功能，我們會發現默認的接口請求地址并不符合我們的要求，需要在環境配置中設置；
- 由于是跨域請求，Chrome瀏覽器需要安裝跨域請求插件，下載地址：https://github.com/YMFE/cross-request/archive/master.zip
- 由于我們的部分接口在請求頭中添加token才能訪問，所以我們先調用登錄接口獲取token；
- 之后在設置->環境配置中添加Authorization頭；
- 再次調用需要登錄的接口，可以正常獲取到數據，返回數據雖然格式化了，但是沒有折疊功能，數據太長的話就不太好看了；
Mock功能
- 在我們調用POST接口提交JSON數據時，默認Mock的JSON數據有點不太符合我們的要求；
- 可以通過接口信息中的編輯->高級設置進行修改；
- 我們可以發現每一個接口信息中都有個Mock地址，當我們后臺接口已經定義好格式，但是沒有實現時，前端可以使用該地址來Mock數據進行調試；
- 調用Mock地址可以獲取到一些測試數據，數據取值返回可以通過上面的Mock設置自行修改；
從Swagger自動同步
- 當我們的接口修改了，API文檔如何同步呢，我們可以通過設置->Swagger自動同步來開啟自動同步功能，有三種數據同步模式可以選擇；
權限管理
如果有新的成員加入進來，需要查看API文檔怎么辦？
- 首先可以通過注冊界面注冊一個成員賬號，此處賬號為test@qq.com:123456；
- 之后使用管理員賬號登錄，然后通過成員列表->添加成員，將用戶添加到相應分組；
- 最后使用成員賬號登錄即可訪問相應API文檔了。
總結
YApi結合Swagger使用果然很強大！之前使用Postman結合Swagger使用時，文檔查看、自動同步的問題都得到了解決，為了保證我們API文檔訪問的安全性還提供了權限管理功能。當API數據格式定義好后，Mock功能讓前端無需后臺實現也可以調試接口。不過對于JSON格式支持有點偏弱，要是能對JSON數據進行折疊顯示就更好了！
參考資料
官方文檔：https://hellosean1025.github.io/yapi/documents/index.html
SpringBoot健康檢查，如何與容器配合？
2020-12-08
Validator，就來這一篇吧
2020-12-08
Docker 命令自動補全必須有
2020-12-06
「五大常用算法」一文圖解分治算法和思想
2020-12-04
寫代碼有這16個好習慣，可以減少80%非業務的bug
2020-12-04
總結
以上是生活随笔為你收集整理的yapi 插件_精神多了，当Swagger遇上YApi，瞬间高大上了！的全部內容，希望文章能夠幫你解決所遇到的問題。
