平台介绍
YApi 是高效、易用、功能强大的 api 管理平台,旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API,YApi 还为用户提供了优秀的交互体验,开发人员只需利用平台提供的接口数据写入工具以及简单的点击操作就可以实现接口的管理。
文档:https://github.com/YMFE/yapi
一、准备工作
1.1 环境
操作系统:CentOS 7 (CentOS-7-x86_64-Minimal-1708)
环境要求:
nodejs(7.6+)
mongodb(2.6+)
二、部署nodejs
部署nodejs尽可能选择偶数版本,因为偶数版本官方有较长的维护时间,故这次选择8.x。
#获取资源
curl -sL https://rpm.nodesource.com/setup_8.x | bash -
#安装
yum install -y nodejs
#查看node版本
node -v
#查看npm版本
npm -v
三、部署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 关闭防火墙
由于需要做数据迁移,所以直接省事将防火墙直接关了。
#关闭,并取消开机启动
systemctl stop firewalld
systemctl disable firewalld
3.5 启动mongodb
systemctl start mongod
四、部署YApi
4.1 安装
#npm install -g yapi-cli --registry https://registry.npm.taobao.org
#yapi server
根据提示,浏览器访问 http://部署YApi服务器的IP:9090。
填写完信息后,点击“开始部署”。(大概等待1分钟)
# 退出当前状态
CTRL + C
4.2 修改配置(配置ladp集成)
这里我们不急着根据提示进行启动,有些参数我们可以通过修改配置达到。
#修改config.json
vim /root/my-yapi/config.json
修改下面的内容(邮箱可以不用163的),wq保存。
4.3 启动
#切换到部署目录下
cd /root/my-yapi
#启动服务
node vendors/server/app.js
由于修改了配置,所以直接访问 http://部署YApi服务器的IP/login。
(ps:没有进行4.2修改配置的话是访问http://部署YApi服务器的IP:3000/login)
五、部署Supervisor
Supervisor是守护进程服务,在没有守护进程之前存在一些问题:
应用程序运行在当前终端发起的子shell中,hangup信号中断后会导致应用退出,我们不可能在长期使用的环境中用一个终端去做长连接。
当服务器重启后,还是需要人工连上服务器启动服务。
进程出现意外终止,等人为发现再连上去开启,这样的反应显然已经慢了。
5.1 安装
yum install python-setuptools -y
easy_install supervisor
5.2 修改配置
#创建目录/etc/supervisor
mkdir /etc/supervisor
#创建supervisord.conf模板文件
echo_supervisord_conf > /etc/supervisor/supervisord.conf
#修改文件supervisord.conf
vim /etc/supervisor/supervisord.conf
增加下面的内容,wq保存。
[include]
files = conf.d/*.conf
��如果服务已启动,修改配置文件可用“supervisorctl reload”命令来使其生效)
#创建目录/etc/supervisor/conf.d/
mkdir -p /etc/supervisor/conf.d/
#修改文件YApi.conf
vim /etc/supervisor/conf.d/YApiGhost.conf
增加下面的内容,wq保存。
[program: YApiGhost]
command=node vendors/server/app.js ; 运行程序的命令
directory=/root/my-yapi ; 命令执行的目录
autorestart=true ; 程序意外退出是否自动重启
stderr_logfile=/var/log/YApiGhost.err.log ; 错误日志文件
stdout_logfile=/var/log/YApiGhost.out.log ; 输出日志文件
environment=ASPNETCORE_ENVIRONMENT=Production ; 进程环境变量
user=root ; 进程执行的用户身份
stopsignal=INT
5.3 启动
#根据supervisord.conf启动守护进程
supervisord -c /etc/supervisor/supervisord.conf
#查看进程
ps -ef | grep YApiGhost
如果存在YApiGhost 进程则代表运行成功。
5.4 设置为开机启动
#修改文件supervisord.service
vim /usr/lib/systemd/system/supervisord.service
添加下面的内容,wq保存。
[Unit]
Description=Supervisor daemon
[Service]
Type=forking
ExecStart=/usr/bin/supervisord -c /etc/supervisor/supervisord.conf
ExecStop=/usr/bin/supervisorctl shutdown
ExecReload=/usr/bin/supervisorctl reload
KillMode=process
Restart=on-failure
RestartSec=42s
[Install]
WantedBy=multi-user.target
#开机启动
systemctl enable supervisord