前言
Yapi是去哪儿网开源的一款接口管理工具。接口的文档的管理是一件比较痛苦的事情,后端开发不得不使用很长的时间去维护繁杂冗余的文档,而前端开发也因为文档的不精确也浪费开发时间。
工作中接口返回的参数值包含很多的异常场景,前端不得不写一大串的判断逻辑。配合前段调试需要模拟很多场景,比较费时费力,而且很多场景到了项目后期才能调试,在提交测试时时间就会显得很紧张。
总结起来文档式的接口管理方式浪费心里和时间,Yapi这款工具的旨意将接口作为一个公共的可视化的方式打通前段、后台、测试环节,整合在一块,共同使用维护,提高接口的维护成本。这款工具免费开源,部署简单,还具有官方文档。
环境依赖
操作系统:Centos 7
环境要求:NodeJS > 7.6 MongoDB > 2.6 Git
依赖安装
NodeJS,MongoDB,GitYapi安装
1:添加npm源,启动Yapi安装程序
npm install -g yapi-cli --registry https://registry.npm.taobao.org //添加源
yapi server //启动Yapi安装程序
执行结果:
2:执行 yapi server是为了启动可视化安装程序,然后再浏览器打开截图上的提示地址:http://ip:9090,进入Yapi配置页面,如下图:
3:在打开的部署配置页面填写对应的配置信息,包括安装目录,MongoDB服务账号密码,管理员邮箱等信息,这些信息用来初始化Yapi服务,填写完配置,点击开始部署,等待完成部署,如下图所属:
4:根据部署日志截图上的提示信息,在服务器上启动服务,命令如下:
node vendors/server/app.js //该目录就是在第二步配置的安装目录
5:访问Yapi服务,测试服务是否安装正确,浏览器打开:http://ip:3000,Yapi默认服务端口为3000,测试成功如下图: