1. yapi简介
YApi 是一款多人协作的 api 管理平台,提供了 api 文档管理,api 数据 模拟(Mock),调试和自动化测试 api 等功能。主要解决前后端分离带来的以下痛点:
- 接口文档不可靠。很多小伙伴管理接口文档,有使用wiki的,有word文档的,甚至还有用聊天软件口口相传的,后端接口对于前端就像一个黑盒子,经常遇到问题是接口因未知原因增加参数了,参数名变了,参数被删除了。
- mock 数据生成方案没有统一出口。我们都有这样的经历,前端开发功能依赖后端,解决方案有自己在代码注入json的,还有后端工程师临时搭建一套测试数据服务器,这种情况下势必会影响工作效率和代码质量,也不能及时进行更新。
- 资源分散,无法共享。接口调试每个开发者单独维护一套Postman接口集,每个人无法共用其他人的接口集,存在大量重复填写请求参数工作,最重要的是postman没法跟接口定义关联起来,导致后端没有动力去维护接口文档。
- 集成 api 自动化测试困难。yapi 提供了可视化的 api 自动化测试方案,只需要简单的填写参数,增加断言,就能实现 api 自动化测试。
项目源码:https://github.com/YMFE/yapi
帮助文档:https://hellosean1025.github.io/yapi/documents/index.html
2. 环境搭建
2.1 安装 Node
Window:
直接下载安装,地址:https://nodejs.org/en/
Linux:
2.2 安装 MongoDB
Window:
直接下载安装,地址:https://www.mongodb.com/
Linux:
2.3 安装yapi
|
|
在线安装成功后,提示:
初始化管理员账号成功,账号名:”test@xxx.com”,密码:”ymfe.org”
部署成功,请切换到部署目录,输入: “node vendors/server/app.js” 指令启动服务器, 然后在浏览器打开 http://127.0.0.1:3000 访问
根据提示,请切换到部署目录,输入: “node vendors/server/app.js” 指令启动服务器
这时候就部署成功了,但是在命令窗口前端运行,一关掉就停了。
2.4 安装pm2
|
|
END.
点击量 次