Yapi是去哪儿网开源的一款接口管理工具。接口的文档的管理是一件比较痛苦的事情，后端开发不得不使用很长的时间去维护繁杂冗余的文档，而前端开发也因为文档的不精确也浪费开发时间。
工作中接口返回的参数值包含很多的异常场景，前端不得不写一大串的判断逻辑。配合前段调试需要模拟很多场景，比较费时费力，而且很多场景到了项目后期才能调试，在提交测试时时间就会显得很紧张。
总结起来文档式的接口管理方式浪费心里和时间，Yapi这款工具的旨意将接口作为一个公共的可视化的方式打通前段、后台、测试环节，整合在一块，共同使用维护，提高接口的维护成本。
这款工具免费开源，部署简单，还具有官方文档。
1.部署nodejs
# 获取资源
curl -sL https://rpm.nodesource.com/setup_8.x | bash -
# 安装
yum install -y nodejs
# 查看node版本
node -v
2.部署mongodb
# 修改文件
vi /etc/yum.repos.d/mongodb-org-4.0.repo
添加下面的内容，wq保存。
[mongodb-org-4.0]
name=MongoDB Repository
baseurl=https://repo.mongodb.org/yum/redhat/7/mongodb-org/4.0/x86_64/
gpgcheck=1
enabled=1
gpgkey=https://www.mongodb.org/static/pgp/server-4.0.asc
# 安装
yum install -y mongodb-org
3.禁用selinux
官方教程有提到selinux对mongodb会产生负面影响，故选择禁用。
# 修改config文件
vim /etc/selinux/config
将SELINUX=enforcing改为SELINUX=disabled，wq保存。
# 重启OS
reboot
4.可视化部署
执行 yapi server 启动可视化部署程序，输入相应的配置和点击开始部署，就能完成整个网站的部署。部署完成之后，可按照提示信息，执行 node/{网站路径/server/app.js} 启动服务器。在浏览器打开指定url, 点击登录输入您刚才设置的管理员邮箱，默认密码(ymfe.org) 登录系统（默认密码可在个人中心修改）。
npm install -g yapi-cli --registry https://registry.npm.taobao.org
yapi server
根据提示，浏览器访问 http://部署YApi服务器的IP:9090
5.启动、访问YApi站点
# 切换到部署目录下
cd /root/my-yapi
# 启动服务
node vendors/server/app.js
6.安装pm2工具管理NodeJS
npm install -g pm2 //安装
cd /YAPI根目录
pm2 start vendors/server/app.js //添加yapi进程到pm2管理模块中
pm2 startup //生成自启脚本，保持当前进程活跃
pm2 save //保存当前进程状态
网友评论