YApi二次開發環境部署

YApi 是去哪兒網大前端技術中心開源的一個可視化的接口管理平臺。下面是在CentOS7下搭建二次開發環境步驟。

1 安裝MongoDB

具體安裝參考CentOS7安裝MongoDB

2 安裝Node.js和npm

具體安裝參考CentOS下安裝nvm

Node.js版本7.6.0，npm版本大於5.0

查看Node.js版本

node –v

查看npm版本

npm –v

3 部署yapi

mkdir yapi
cd yapi
git clone https://github.com/YMFE/yapi.git vendors --depth=1 //或者下載 zip 包解壓到 vendors 目錄
cp vendors/config_example.json ./config.json //複製完成後請修改相關配置
cd vendors
npm install --production --registry https://registry.npm.taobao.org  //安裝依賴
npm run install-server //安裝程序會初始化數據庫索引和管理員帳號，管理員帳號名可在 config.json 配置

3.1 建立工程目錄

mkdir yapi 
cd yapi
git clone https://github.com/YMFE/yapi.git vendors --depth=1  //或者下載 zip 包解壓到 vendors 目錄

3.2 修改配置文件

cp vendors/config_example.json ./config.json //複製完成後請修改相關配置
vi ./config.json

配置修改以下，主要配置 MongoDB 數據庫：

{
  "port": "3011",
  "adminAccount": "admin@admin.com",
  "db": {
    "servername": "10.228.129.235",
    "DATABASE": "yapi",
    "port": 27017,
    "authSource": ""
  },
  "mail": {
    "enable": true,
    "host": "smtp.163.com",
    "port": 465,
    "from": "***@163.com",
    "auth": {
      "user": "***@163.com",
      "pass": "*****"
    }
  }
}

3.3 安裝依賴

cd vendors
npm install  --registry https://registry.npm.taobao.org  //安裝依賴

3.4 初始化

npm run install-server  //安裝程序會初始化數據庫索引和管理員帳號，管理員帳號名可在 config.json 配置

3.5 啓動開發機

若要啓動開發環境服務器，執行以下命令：

npm run dev   //啓動服務器後，請訪問 127.0.0.1:{config.json配置的端口}，初次運行會有個編譯的過程，請耐心等候

4 安裝打包工具

安裝webpack

npm install -g webpack  //全局安裝
npm install --save-dev webpack  //安裝到項目目錄

安裝ykit

npm install ykit -g

若安裝過程當中，出現npm ERR!報錯，解決方法以下：

npm install ykit -g --unsafe-perm=true --allow-root

5 用ykit執行打包

ykit pack -m

若打包過程當中，出現目錄權限Permission denied報錯，解決方法以下：

chmod 777 文件或目錄

打包成功後，會在vendors/static/prd文件夾下生成以下壓縮文件：

6 啓動生產環境服務器

node server/app.js

服務啓動成功後，顯示以下信息：

7 服務後臺運行

使用以下命令：

nohup node server/app.js &

查看進程

ps -aux

殺掉進程

kill -9 具體pid號

8 相關問題

ykit打包成功，啓動生產環境服務器後，打開瀏覽器報錯：

報錯緣由：二次開發不支持windows環境，請在CentOS或者MacOS環境下進行二次開發。