YApi由去哪兒網移動架構組(簡稱ymfe,一群由fe、ios和android工程師共同組成的最具想象力、創造力和影響力的大前端團隊)開源的可視化接口管理工具。
旨在為開發、產品、測試人員提供更優雅的接口管理服務。可以幫助開發者輕松創建、發布、維護 API,YApi 還為用戶提供了優秀的交互體驗,開發人員只需利用平台提供的接口數據寫入工具以及簡單的點擊操作就可以實現接口的管理。
環境要求
- nodejs(7.6+)
- mongodb(2.6+)
- git
一、mongodb安裝
mongodb下載地址:https://www.mongodb.com/download-center/community
根據你的系統下載 32 位或 64 位的 .msi 文件,下載后雙擊該文件,按操作提示安裝即可。
安裝過程中,你可以通過點擊 "Custom(自定義)" 按鈕來設置你的安裝目錄。
下一步安裝 "install mongoDB compass" 不勾選(當然你也可以選擇安裝它,可能需要更久的安裝時間),MongoDB Compass 是一個圖形界面管理工具,我們可以在后面自己到官網下載安裝
安裝好后,需重啟電腦。
二、安裝Yapi
1. 安裝向導程序
npm install -g yapi-cli --registry https://registry.npm.taobao.org
yapi server
瀏覽器中運行http://127.0.0.1:9090/
點擊開始部署。部署完成后
在部署目錄,運行node vendors/server/app.js
瀏覽器中運行http://127.0.0.1:3000
建個bat文件,包括如下內容,下次可直接運行
e:
cd E:\my-yapi
node vendors/server/app.js
三、調試接口
1、chrome插件安裝:cross-request
百度雲:https://pan.baidu.com/s/1iB6GMXRqaj9Ovs8KbFFBhA
提取碼: akdk
(1)、下載完成后,解壓壓縮包
(2)、進入到Chrome的【擴展程序】頁面 chrome://extensions/,首先開啟【開發者模式】,一定要先開啟開發者模式
(3)、在Chrome菜單中選擇【擴展程序】->【加載以解壓的擴展程序】->【選中壓縮包內容】-> 【選中3.0.0的目錄】進行插件安裝,安裝完成后重啟Chrome就可以正常使用了。
2、查看運行結果
官網教程地址:https://hellosean1025.github.io/yapi/documents/index.html