技术选型
当下互联网行业已经从大鱼吃小鱼演变成快鱼吃慢鱼的时代了,从用户需求转化成企业服务的能力,研发效能的高低对用户需求转化速率起到了至关重要的作用,而API服务的研发效能是当中非常重要的一环。
随着公司的发展,研发人员越来越多,公司产品多元化,模块复杂度不断提升,API的研发效能也成为了决定公司研发能力的关键因素之一,对API研发管理,研发效率也有了新的挑战。一个好的 Mock API
应旨在为开发、产品、测试人员提供更优雅的接口管理服务、帮助开发者轻松创建、发布、维护 API。
建议
RAP1
长达3年+ 未更新维护,RAP2
长达1年+未更新维护,开源项目一档超过半年未迭代更新,选择就需要慎重,同时对比阿里对待开源的态度,不能商用大部分是KPI考核项目
如果是JAVA项目,可以采用 YAPI
+ Swagger
的方案,无缝集成,其它类型的项目也可以单独使用YAPI
使用官方提供的 yapi-cli
部署 YApi 平台。执行 yapi serverv
启动可视化部署程序
npm install -g yapi-cli --registry https://registry.npm.taobao.orgyapi server
注意事项
# node 版本不能高于 12node -v
访问 http://localhost:9090 开始正式部署 YAPI
,部署完成之后,按照提示信息,执行 node /{应用路径/server/app.js}
启动服务器。在浏览器访问 http://localhost:3000 进行登录。
点击登录输入您刚才设置的管理员邮箱
,默认密码为ymfe.org
登录系统(默认密码可在个人中心修改)
利用pm2方便服务管理维护。
npm install pm2 -g //安装pm2cd {项目目录}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} //更新到指定版本
管理员可以添加与项目相关的项目组以及成员维护
项目创建
在分组空间中创建项目信息
添加成员:组长将组员加入到YAPI中
支持导出HTML
、Swagger JSON
、Markdown
等格式,如需 PDF
可以通过第三方格式转换成 PDF
、WORD
等常规格式
YAPI
可以根据具体情况配置全局Token及不同地址
内置插件调试
Mock 调试
测试集合
可以保留曾经测试的记录,及断言验证