YApi介绍

YApi是国内开源的一款面向开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API。
支持私有化部署、开源免费、无缝兼容swagger.json格式标准。

安装顺序

下面我就介绍一下在CentOS中私有化部署的操作流程，由于官方文档存在问题，我这里会着重指出一些注意事项。

安装必备环境

安装nodejs与npm

注意：YApi支持nodejs版本为 7.6 - 12，14以上启动会报错。

  • 安装node.js和npm包管理
yum install nodejs
yum install npm
  • 安装node n进行版本管理，这里我们切换到12.13.0这个nodejs版本
npm install -g n
n 12.13.0

安装MongoDB

注意：YApi支持的MongoDB版本要大于2.6

  • 安装MongoDB程序
yum install -y mongodb-org
  • 配置MongoDB，修改置文件 mongodb.conf
vi mongodb.conf

# 设置数据文件的存放目录，改成你自己的数据盘
dbpath = /usr/local/mongodb/mongodb3.2.4/bin/data/test/db

# 设置日志文件的存放目录及其日志文件名，改成你自己的数据盘
logpath = /usr/local/mongodb/mongodb3.2.4/bin/data/test/logs/mongodb.log

# 设置端口号（默认的端口号是 27017）
port = 27017

# 设置为以守护进程的方式运行，即在后台运行
fork = true

# nohttpinterface = true
nohttpinterface = true

按英文状态下的“:wq”保存并退出；
  • 启动MongoDB服务
1）启动
systemctl start mongod
2）重启
systemctl restart mongod
3）关闭
systemctl stop mongod

安装git

yum -y install git

安装YApi-CLI脚手架

  • 安装
npm install -g yapi-cli --registry https://registry.npm.taobao.org
  • 启动
yapi server

YApi-CLI默认访问端口是9090，如果9090已被占用，可以手动修改启动端口。正常来说不用修改。

  • 找到yapi-cli的路径
/usr/lib/node_modules/yapi-cli/src/commands
  • 编辑server.js
vi server.js
  • 修改监听端口
修改 app.listen(9090)

通过YApi-CLI可视化界面安装YApi

  • 浏览器访问你的服务器9090端口，打开可视化部署页面
    yapi-cli

注意：部署版本不要选择1.10.1和1.10.2，这两个版本会调用阿里内网地址，部署会失败。必须选择1.9.3以下版本。

  • 点击开始部署后，会看到执行日志
    yapi-cli2

启动与运行

安装完成后，我们可以敲命令启动YApi后台程序了。

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

运行成功后，我们通过浏览器访问YApi，如下图所示：
yapi4

通过pm2管理yapi服务

但是通过命令启动的YAPI服务，一关掉终端就停止运行了，所以我们需要使用PM2来将YAPI作为后台服务运行。

安装pm2

npm install -g pm2

使用pm2启动yapi服务

pm2 start opt/yapi/my-yapi/vendors/server/app.js

pm2

至此，YAPI的整个部署流程我们就走完了，如果在部署的过程中，有什么问题可以在我的博客留言，我会尽量帮助大家解决。

PS：如何配置邮件提醒

找到并修改config.json配置文件中邮件发送配置内容
yapi3
修改完成后，重启YApi即可。