Yapi部署指南

一、Yapi部署基礎

Yapi是一個基於Node.js的、可本地部署的、信息管理系統，它的主要作用是幫助團隊協作完成接口管理、文檔管理等工作，提高接口開發效率，實現前後端聯調。

部署Yapi需要準備好以下軟件和環境：

1、Node.js和npm

2、MongoDB

3、nginx或apache

4、pm2

下面我們來逐步操作實現Yapi部署。

二、安裝和配置MongoDB

MongoDB是一個免費的開源數據庫，它捨棄了傳統的關係型數據庫的表結構，而是採用了文檔數據模型存儲數據。Yapi需要使用MongoDB存儲數據，因此需要先安裝並配置MongoDB。

1、安裝MongoDB

$ sudo apt-get install mongodb

2、配置MongoDB

首先，在 /etc/mongodb.conf 文件中配置 MongoDB 的監聽地址。默認情況下 MongoDB 監聽在 127.0.0.1:27017，如果想創建一個只監聽了 192.168.100.100:27017 的 MongoDB 實例，可以進行以下配置：

bind_ip = 192.168.100.100
port = 27017

3、啟動MongoDB

$ sudo service mongodb start

啟動成功後，可以查看 MongoDB 的狀態：

$ sudo service mongodb status

三、安裝和配置Yapi

1、安裝Yapi

全局安裝 Yapi 並配置數據庫信息和管理員賬號：

$ npm install -g yapi-cli --registry https://registry.npm.taobao.org

2、初始化Yapi

在 Yapi 的根目錄運行初始化命令，按照提示填寫基本信息和數據庫配置信息即可。接着運行以下命令：

$ yapi server

3、配置日誌輸出到log文件中

$ yapi server > server.log 2>&1 &

在 /etc/profile 文件中添加環境變量：

export YAPI_HOME=/data/yapi/

在 /etc/bashrc 文件中添加：

source /etc/profile

四、使用nginx或apache作為反向代理

1、安裝nginx或apache

在Ubuntu 16.04中安裝nginx：

$ sudo apt-get update
$ sudo apt-get install nginx

2、配置nginx

在 /etc/nginx/sites-available/default 文件中配置反向代理信息：

location /yapi {
    proxy_pass http://127.0.0.1:3000;
}

3、重啟nginx服務

sudo service nginx restart

五、使用pm2託管Yapi

1、全局安裝pm2

$ npm install -g pm2

2、啟動Yapi

$ pm2 start /usr/local/lib/node_modules/yapi/app.js --watch --name yapi

3、保存配置信息

$ pm2 save

4、設置開機啟動

在 /etc/rc.local 文件的末尾添加以下命令：

su - yapi -c "pm2 start /usr/local/lib/node_modules/yapi/app.js --watch --name yapi"

這樣在每次服務器重啟後，pm2 會自動啟動 Yapi。