首先,来对比一下主流的接口管理工具:
接口工具 | 在线调试 | mock数据 | 项目管理 | 团队协作 | 易维护 |
---|---|---|---|---|---|
Word文档 | × | × | × | 差 | 差 |
Markdown | × | × | × | 一般,编辑需要解决冲突 | 较差 |
Postman | √ | 支持,但配置稍微繁琐 | √ | 一般 | 一般 |
Swagger | √ | 支持,但需要自己搭建服务器 | √ | 较好 | 较好 |
RAP | × | 支持,可以灵活配置 | √ | 好 | 较好 |
YAPI | √ | 支持,可以灵活配置 | √ | 好 | 较好 |
首先来看一下YApi具有一下实用的功能:
项目权限管理
按照项目组划分权限,也可以通过单独的项目设置权限。
演示链接:项目权限管理
可视化接口管理
基于 websocket 的多人协作接口编辑功能和类 postman 测试工具,让多人协作成倍提升开发效率。
演示链接:接口管理
Mock Server
强大的Mock Server:
基于MockJS支持自动生成默认mock数据;
需要特殊的返回值,也可以通过高级Mock功能进行设置;
全局mock设置,让所有接口返回相同字段返回统一的mock数据;
演示链接:Mock数据
支持自动自定义mock数据
演示链接:全局Mock脚本
自动化测试
完善的接口自动化测试,保证数据的正确性。
演示点:
- 创建测试集合
- 编辑测试用例
- 编辑请求参数(mock,指定值,读取上一个接口)
- 编写断言脚本
- 运行自动化测试
- 服务端自动化测试,支持脚本触发构建
演示链接:自动化测试
数据导入
支持导入 swagger, postman, har 数据格式,方便迁移旧项目。
- 手动导入
演示链接:数据导入
-
通过命令行导入
命令行演示
插件机制
强大的插件机制,满足各类业务需求,支持二次开发。
项目中应用
parent code api项目开发管理流程
直接从master拉取特性分支,代码编写完成之后发起MR,代码审查之后直接合并到master,接收MR的时候需要选择删除local-xxx
分支,local分支的生命周期同MR。
具体执行流程:
实例演示