最近公司准备找一款可视化接口管理工具来替换Swagger,综合评估了YApi、RAP2、极客的后,决定先用YAPI的来试试水,不多讲,干活。
YApi是一款在线接口管理工具,它主要有权限管理、可视化接口管理、Mock Server、自动化测试、数据导入、插件机制。
主要为开发、产品、测试人员提供更优雅的接口管理服务,可以帮助开发者轻松的创建、发布、维护API。
操作系统:CentOS 7
环境要求:
(1)NodeJS(2)MongoDB(3)Git(4)pm2
一、安装
1.1 安装Node
在安装Node的时候,可以先安装 wget,如果已经安装过了就跳过。
--安装wget --下载node --解压 --重命名 --创建软连接,放到 /usr/local/bin 文件夹下 --查看版本 |
备注说明
|
---|
--如果npm安装失败,执行下面的命令: --在文件的底部,添加下面两行代码: --更新配置 source /etc/profile 有的时候用npm安装其他插件可能会失败,遇到这种情况,我们可以使用cnpm npm install -g cnpm --registry=https://registry.npm.taobao.org |
1.2 安装MongoDB
<后面会在MongoDB中作出补充,因为配置的蛮多的>
1.3 安装Git
执行命令:yum -y install git
1.4 安装YApi
--安装命令 npm install -g yapi-cli --registry https://registry.npm.taobao.org --启动服务 yapi server --启动进程,进入yapi的安装目录,进入服务文件夹 cd {install_path}/nodejs/lib/node_modules/yapi-cli/src/my-yapi/vendors/server node ./app.js 安装成功,测试运行,当然这个进程会随着控制台的关闭而挂掉,我们要永久守护这个进程,需要用到pm2。 |
1.5 安装pm2
pm2是一个进程管理工具,可以用它来管理node进程,并查看node的状态,当然也支持性能监控,进程守护,负载均衡等功能
--全局安装命令 npm install -g pm2 安装好之后,进入目录 cd {install_path}/nodejs/lib/node_modules/yapi-cli/src/my-yapi/vendors/ 运行命令: pm2 start server/app.js --watch 此时,可能会出现 “未找到命令”或“command not found”的错误,这时,回到我们安装pm2完成时,在控制台会输出几个路径地址,找到 {install_path}/nodejs/bin/pm2 -> {install_path}/nodejs/lib/node_modules/pm2/bin/pm2
将{install_path}/nodejs/lib/node_modules/pm2/bin/pm2创建一个全局的软连接,命令如下: ln -s {install_path}/nodejs/lib/node_modules/pm2/bin/pm2 /usr/local/bin 测试一下是否成功 pm2 -v 或 pm2 --version,如果返回版本号,则说明软连接创建成功,这时,我们继续执行YApi的进程守护命令 pm2 start server/app.js --watch 如果出现下图,则配置成功
|
pm2常用命令示例(在要守护的项目进程目录下运行,按需要选择,不能照搬哈,否则后果自负)
|
---|
2.1 启动进程/应用 pm2 start bin/www 或 pm2 start app.js 2.2 重命名进程/应用 pm2 start app.js --name wb123 2.3 添加进程/应用 watch pm2 start bin/www --watch 2.4 结束进程/应用 pm2 stop www 2.5 结束所有进程/应用 pm2 stop all 2.6 删除进程/应用 pm2 delete www 2.7 删除所有进程/应用 pm2 delete all 2.8 列出所有进程/应用 pm2 list 2.9 查看某个进程/应用具体情况 pm2 describe www 2.10 查看进程/应用的资源消耗情况 pm2 monit 2.11 查看pm2的日志 pm2 logs 2.12 若要查看某个进程/应用的日志,使用 pm2 logs www 2.13 重新启动进程/应用 pm2 restart www 2.14 重新启动所有进程/应用 pm2 restart all |
二、配置
|
---|
--进入目录 cd {install_path}/nodejs/lib/node_modules/yapi-cli/src/my-yapi --调整配置 vi ./config.json--启动服务 node server/app.js |