YApi 简介
YApi
由 YMFE
(去哪儿)开源,旨在为开发、产品、测试人员提供更优雅的接口管理服务,可以帮助开发者轻松创建、发布、维护 API
。YApi
还为用户提供了优秀的交互体验,开发人员只需利用平台提供的接口数据写入工具以及简单的点击操作就可以实现接口的管理。
- 权限管理
YApi
成熟的团队管理扁平化项目权限配置满足各类企业的需求 - 可视化接口管理 基于
websocket
的多人协作接口编辑功能和类 postman 测试工具,让多人协作成倍提升开发效率 - Mock Server 易用的
Mock Server
,再也不用担心mock
数据的生成了 - 自动化测试 完善的接口自动化测试,保证数据的正确性
- 数据导入 支持导入
swagger, postman, har
数据格式,方便迁移旧项目 - 插件机制 强大的插件机制,满足各类业务需求
Yapi
支持内网部署,只需在管理员或内网某台机器上安装部署一次,团队其他成员不需要部署,访问相应的地址即可使用。本部分内容只需负责配置环境人员阅读,需要相关人员具有基本的node
与mongodb
知识。
内网部署
环境要求
- nodejs(7.6+)
- mongodb(2.6+)
安装
使用 YMFE
提供的 yapi-cli
工具,部署 YApi
平台是非常容易的。执行 yapi server
启动可视化部署程序,输入相应的配置和点击开始部署,就能完成整个网站的部署。部署完成之后,可按照提示信息,执行 node/{网站路径/server/app.js}
启动服务器。在浏览器打开指定 url
, 点击登录输入您刚才设置的管理员邮箱,默认密码为 ymfe.org
登录系统(默认密码可在个人中心修改)。
npm install -g yapi-cli --registry https://registry.npm.taobao.org
yapi server
服务管理
利用pm2方便服务管理维护。
npm install pm2 -g //安装pm2
cd {项目目录}
pm2 start "vendors/server/app.js" --name yapi //pm2管理yapi服务
pm2 info yapi //查看服务信息
pm2 stop yapi //停止服务
pm2 restart yapi //重启服务
升级
升级项目版本是非常容易的,并且不会影响已有的项目数据,只会同步 vendors 目录下的源码文件。
cd {项目目录}
yapi ls //查看版本号列表
yapi update //更新到最新版本
yapi update -v {Version} //更新到指定版本