YApi-高效、易用、功能強大的可視化接口管理平臺—部署篇

YApi https://yapi.ymfe.org/ 是由去哪兒網移動架構組(簡稱YMFE，一羣由FE、iOS和Android工程師共同組成的最具想象力、創造力和影響力的大前端團隊)開源的可視化接口管理工具，一個可本地部署的、打通先後端及QA的接口管理平臺，YApi旨在爲開發、產品和測試人員提供更優雅的接口管理服務，能夠幫助開發者輕鬆建立、發佈和維護不一樣項目，不一樣平臺的API。有了YApi，咱們能夠很方便的測試、管理和維護多個項目的API接口，不像Swagger那樣是隨應用生和滅的(且線上環境下大多數須關閉)，YApi是一個獨立的服務平臺。

下面介紹windows下部署YApi接口管理平臺的相關步驟。

內網部署

環境要求：

• nodejs（7.6+)
• mongodb（2.6+）

1.安裝nodejs

nodejs官網 https://nodejs.org 下載安裝包安裝。

2.安裝mongodb

MongoDB官網 https://www.mongodb.com/download-center/community 下載安裝包安裝。安裝過程當中會提示你安裝圖形界面管理工具MongoDB Compass，挺慢的，記得把√去掉，之後本身去官網下載安裝。

3.安裝YApi的部署腳手架

npm install -g yapi-cli
yapi server

效果以下圖所示

按照提示打開地址 http://localhost:9090 按照提示部署，效果以下圖所示

成功後根據提示訪問： 切換到部署目錄，輸入node vendors/server/app.js指令啓動服務器，而後在瀏覽器打開 http://localhost:3000

管理員帳號：hilanmiao@126.com 密碼：ymfe.org

剛進來是空的，你須要建立一個項目,按照教程操做便可。 https://yapi.ymfe.org/documents/index.html

4.服務器管理

若是你使用node vendors/server/app.js指令啓動服務器，那麼當cmd窗口關閉時，node服務就關了，網站就打不開了。推薦使用 pm2 管理 node 服務器啓動，中止，具體使用方法可參考官網的教程，我寫個簡單的。

記得用管理員身份打開CMD窗口

1. 安裝 pm2

npm i -g pm2

2. 安裝並配置 pm2-windows-service

pm2-windows-service能夠將 pm2 安裝成 windows service, 達到開機運行的目的

npm i -g pm2-windows-service

3. 添加pm2環境變量

添加系統環境變量 PM2_HOME=D:\.pm2

右鍵 [個人電腦] - [屬性] - [高級系統設置] - [環境變量] - 新建 [系統變量]

名稱PM2_HOME 路徑D:\.pm2（這路徑根據本身須要定）

4. 安裝服務

以管理員權限打開新的命令行窗口,執行如下命令來安裝服務

pm2-service-install

Perform environment setup ? 選 n, 繼續

此時, PM2服務已安裝成功並已啓動, 能夠經過 Wn+R來查看，輸入services.msc便可看到服務

5. 啓動node程序

下面用 pm2 來啓動咱們本身的服務程序 app.js, 而後告訴 pm2 開機後自動運行我 app.js.繼續在管理員命令行下, cd 切換到yapi的vendors/server/到 app.js 所在目錄

pm2 start app.js --name yApi

6. 查看服務列表

pm2 list

7. 添加到自啓動服務

pm2 save

pm2 save很重要, 它保存當前pm2 正在管理的NodeJS服務, 並在開機後恢復這些服務 至此, 安裝配置完成

8. 卸載服務

pm2-service-uninstall

效果以下圖所示：

5.結尾提示

服務器重啓以後可能須要先啓動Mongodb。

cd C:\Program Files\MongoDB\Server\4.0\bin

mongod.exe --config "C:\Program Files\MongoDB\Server\4.0\bin\mongod.cfg --install -serviceName "MongoDB"

net start MongoDB

pm2 restart all

如今命令已經添加到windows服務上了，之後只須要執行 net start MongoDB就能夠啓動Mongdb了。

如今你能夠在瀏覽器打開 http://localhost:3000 管理你的api了。其餘知識如邀請團隊成員、pm2 啓動 中止等有須要的本身學一下就行了，拜拜。