部署Yapi接口文檔管理工具

今天介紹下Yapi的接口管理工具的部署。

1、準備工做

• 1.1 環境

  操做系統：CentOS 7 （CentOS-7-x86_64-Minimal-1708）
  環境要求:nodejs（7.6+）,mongodb（2.6+）

2、部署nodejs

部署nodejs儘量選擇偶數版本，由於偶數版本官方有較長的維護時間，故此次選擇8.x。

獲取資源

curl -sL https://rpm.nodesource.com/setup_8.x | bash -

安裝

yum install -y nodejs

查看node版本

node -v

查看npm版本

npm -v

3、部署mongodb

mongodb奇數版（如3.5）是開發版本，故選擇安裝v3.4。

• 3.1 添加yum源

修改文件mongodb-3.4.repo

vim /etc/yum.repos.d/mongodb-3.4.repo

添加下面的內容，wq保存。

[mongodb-org-3.4]
name=MongoDB Repository
baseurl=https://repo.mongodb.org/yum/RedHat/$releasever/mongodb-org/3.4/x86_64/
gpgcheck= 0
enabled=1

• 3.2 安裝

yum install -y mongodb-org

• 3.3 禁用selinux

官方教程有提到selinux對mongodb會產生負面影響，故選擇禁用。

修改config文件

vim /etc/selinux/config

將SELINUX=enforcing改成SELINUX=disabled，wq保存。

重啓OS

reboot

• 3.4 關閉防火牆

  因爲須要作數據遷移，因此直接省事將防火牆直接關了。

• 3.5 啓動

service mongod restart

4、部署YApi

• 4.1 安裝

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

根據提示，瀏覽器訪問 http://部署YApi服務器的IP:9090。

填寫完信息後，點擊「開始部署」。（大概等待1分鐘）

• 4.2 初始化帳號

yapi-vendor@1.7.0 install-server /etc/my-yapi/vendors
node server/install.js

• 4.2 修改配置

這裏咱們不急着根據提示進行啓動，有些參數咱們能夠經過修改配置達到。

修改config.json

vim /root/my-yapi/config.json

修改下面的內容（郵箱能夠不用163的），wq保存。

{
  "port": "80",
  "adminAccount": "yizitadmin@yizit.cn",
  "db": {
       "servername": "127.0.0.1",
       "DATABASE": "yapi",
       "port": "27017"
   },
  "mail": {
       "enable": true,
       "host": "smtp.163.com",
       "port": 465,
       "from": "可用於發送郵件的163郵箱",
       "auth": {
           "user": "163郵箱",
           "pass": "163郵箱對應的密碼或受權碼"
       }
  }
}

• 4.3 啓動

  切換到部署目錄下

cd /etc/my-yapi

啓動服務

node vendors/server/app.js

因爲修改了配置，因此直接訪問 http://部署YApi服務器的IP/login。

（ps:沒有進行4.2修改配置的話是訪問http://部署YApi服務器的IP:3000/login）

初始化帳號:`部署填寫的郵箱` , 密碼："ymfe.org"
    登陸後能夠進行修改。

5、用supervisor的部署YApi的守護進程

• 5.1 編寫/etc/supervisor/conf.d/yapi.ini

  [program:yapi]
  directory = /etc/my-yapi
  command=node vendors/server/app.js
  user =root
  autostart=true
  autorestart=true
  startsecs=5
  stderr_logfile=/etc/my-yapi/err.log
  stdout_logfile=/etc/my-yapi/out.log

• 5.2 加載supervisor配置並重啓服務。

  sudo supervisord -c /etc/supervisor/supervisord.conf
  sudo supervisorctl -c /etc/supervisor/supervisord.conf

• 5.3 查看運行狀態
  

  注意：
  1.因爲我是在測試機上部署環境，9090,3000不對外開放，因此我作了反向代理，
  最後的proxy配置以下：

server {
    listen       80;
    server_name  yapi.co;

  location / {
      charset utf-8;
      #開啓http1.1,支持長鏈接
      proxy_http_version 1.1;
      proxy_set_header Upgrade $http_upgrade; 
      proxy_set_header Connection "upgrade";
      #反向代理到3000端口
      proxy_pass http://127.0.0.1:3000;
  }
}

參考：

1.https://www.cnblogs.com/hu-qi/p/yapi.html
2.https://www.linuxidc.com/Linux/2018-01/150513.htm