Linux-安装-Yapi

---

time 20191204

author Venki

ps 内网部署

---

目录指引

• 环境要求
• 安装nodejs
• 安装mongodb
• 安装YApi
• 启动YApi
• nginx代理
• 守护进程管理服务
• Mongodb
• 参考文献

环境要求

回到顶部

1. 如果您是将服务器代理到 nginx 服务器，请配置 nginx 支持 websocket

# 在location /添加
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";

2. 依赖服务

• nodejs（7.6+) (nodejs(7.6+)yapi是用nodejs开发的，所以需要此环境编译运行)
• mongodb（2.6+）(用来存储系统的数据)
• git

安装nodejs

回到顶部

1. 获取资源

# 部署nodejs尽可能选择偶数版本，因为偶数版本官方有较长的维护时间，故这次选择8.x
curl -sL https://rpm.nodesource.com/setup_8.x | bash -

2. 安装

yum install -y nodejs

3. 查看版本

node -v

4. 查看npm版本

npm -v

安装mongodb

回到顶部

1. 添加mongodb源文件

touch /etc/yum.repos.d/mongodb-org.repo

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

# 添加如下内容
[mongodb-org-3.2]
name=MongoDB Repository
baseurl=https://repo.mongodb.org/yum/redhat/$releasever/mongodb-org/3.2/x86_64/
gpgcheck=1
enabled=1
gpgkey=https://www.mongodb.org/static/pgp/server-3.2.asc

2. 安装mongodb

yum install -y mongodb-org

3. 启动mongodb

service mongod start

4. 设置开机启动

chkconfig mongod on

5. 配置远程访问

vim /etc/mongod.conf

注释 bindIp: 127.0.0.1
#bindIp: 127.0.0.1

6. 重启mongod

service mongod restart

安装YApi

回到顶部

1. 安装方式一(不好意思没有部署成功)

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

yapi server

2. 安装方式二(部署成功)

mkdir yapi

cd yapi

# 或者下载 zip 包解压到 vendors 目录
git clone https://github.com/YMFE/yapi.git vendors 
# 或者（clone 整个仓库大概 140+ M，可以通过 `git clone --depth=1 https://github.com/YMFE/yapi.git vendors` 命令减少，大概 10+ M）
# 我用的是这个小的包，大包下载太慢
git clone --depth=1 https://github.com/YMFE/yapi.git vendors

# 复制完成后请修改相关配置
cp vendors/config_example.json ./config.json

{
  # 访问端口号
  "port": "52015",
  # yapi管理员初始化登录账号 密码默认ymfe.org
  "adminAccount": "admin@admin.com",
  # mongodb 数据库配置
  "db": {
    "servername": "127.0.0.1",
    "DATABASE": "yapi",
    "port": 27017,
    "user": "venki",
    "pass": "1q2w3e4r5t@!",
    "authSource": ""
  },
  "mail": {
    "enable": true,
    "host": "smtp.163.com",
    "port": 465,
    "from": "***@163.com",
    "auth": {
      "user": "***@163.com",
      "pass": "*****"
    }
  }
}

cd vendors

npm install --production --registry https://registry.npm.taobao.org

# 安装程序会初始化数据库索引和管理员账号，管理员账号名可在 config.json 配置
npm run install-server 

# 此步骤可能报错，意识就是
SCRAM-SHA-1 authentication failed for test1 on yapi from client 127.0.0.1 ; UserNotFound: Could not find user test1@yapi

# 原因就是：针对是3.0.3以前版本已经ok，如果是3.0.3，mongodb加入了SCRAM-SHA-1校验方式，需要第三方工具配合进行验证

# 解决方法 ,下面的配置信息要根据config.json进行配置

use yapi

db.dropUser("venki")

db.createUser({user:'venki',pwd:'1q2w3e4r5t@!',roles:[{role:'dbOwner',db:'yapi'}]})

# 启动服务器后，请访问 127.0.0.1:{config.json配置的端口}，初次运行会有个编译的过程，请耐心等候
node server/app.js 

3. 重要文件位置（方式二安装）

# yapi日志文件位置
/usr/local/src/yapi/log

# mongodb日志文件位置
/var/log/mongodb

启动YApi

回到顶部

1. 启动

yapi server

nginx代理

回到顶部

1. 通过域名访问yapi

# nginx配置如下
server {
  server_name my.gl.yapi.com;   # 请修改为你的域名

  client_max_body_size 250m;

  location / {
    proxy_http_version 1.1;
    proxy_set_header Upgrade $http_upgrade;
    proxy_set_header Connection "upgrade";
    proxy_set_header    Host $http_host;
    proxy_set_header   X-Frame-Options   SAMEORIGIN;
    proxy_set_header   X-Real-IP         $remote_addr;
    proxy_set_header    X-Forwarded-For $proxy_add_x_forwarded_for;

    proxy_read_timeout 300; # Some requests take more than 30 seconds.
    proxy_connect_timeout 300; # Some requests take more than 30 seconds.
    proxy_redirect     off;
    proxy_pass http://127.0.0.1:52015/;
  }

  # Enable gzip compression as per rails guide: http://guides.rubyonrails.org/asset_pipeline.html#gzip-compression
  # WARNING: If you are using relative urls do remove the block below
  # See config/application.rb under "Relative url support" for the list of
  # other files that need to be changed for relative url support
  location ~ ^/(assets)/  {
    expires max;
    add_header Cache-Control public;
  }

  error_page 502 /502.html;
}
# 重启nginx
service nginx restart

守护进程管理服务

回到顶部

1. supervisor编写守护进程

cd /etc/supervisor/supervisord.conf.d

vi yapi.conf

# 添加如下内容
[program:yapi]
process_name=%(program_name)s_%(process_num)02d
command=/usr/bin/node /usr/local/src/yapi/vendors server/app.js
autostart=true
autorestart=true
user=root
numprocs=1
redirect_stderr=true
stdout_logfile=/usr/local/src/yapi/log/node_server.log # 日志记录

# 重新载入
supervisorctl update

# 查看进程
supervisorctl status

> yapi:yapi_00                       RUNNING   pid 21581, uptime 0:02:55

2. 如何查看supervisor是否起作用

• 可以打印出stdout_logfile=/usr/local/src/yapi/log/node_server.log # 日志记录，然后边杀死程序进行检查
• supervisorctl status只要在运行就没有问题

Mongodb

回到顶部

参考文献

回到顶部

• 内网部署
• mongodb3.03以上开启认证,解决程序认证连接报错以及第三方客户端无法认证问题
• Yapi-nginx部署