在我們日常開發中,後端開發者做接口開發時,都要輸出一份規範的、完整的、清晰的接口文檔。很多公司還才用word文檔來輸出,這樣以後的接口維護是非常困難的,這次我來分享一個個人覺得比較好的在線接口管理工具,管理接口真的很方便,這!就是YApi
YApi可以進行二次開發的,所以,可以根據公司的業務,部署到本地,下面我們一起來看看如何部署,很簡單~
環境要求
- 安裝MongoDB
YApi的數據存儲是使用了MongoDB,所以,在部署YApi前,必須保證安裝上MongoDB,不管在Linux/Windows下安裝,都很簡單的,我就不做介紹了
- 安裝NodeJs
YApi的部署需要用到,都很簡單的,我就不做介紹了
部署流程
以下是在Windows系統部署
- 在本地創建下載YApi源碼
git clone https://github.com/YMFE/yapi.git
- 安裝YApi-cli服務
npm install -g yapi-cli --registry https://registry.npm.taobao.org
- 啓動安裝服務
yapi server
然後在瀏覽器輸入:127.0.0.1:9090,打開YApi初始化安裝界面
根據自己配置項,填寫好後,點擊【開始部署】即可,在部署過程中,請儘量不要點擊頁面,防止終端,大概4分鐘左右部署完成。
- 部署完成後,啓動服務
在安裝源碼中,我們找到自己配置項中訪問目錄,如默認的:my-yapi
開始啓動服務
node vendors/server/app.js
- 訪問安裝項目
http://部署YApi服務器的IP:3000,端口可以自行配置,使用默認的也行,保證不衝突即可,完成手工,剩下的就自己探索了~