作为一个后端开发,我做的大部分项目一般都是基于 Swagger 来管理 API 文档,基于 Postman 来做接口调试,基于 JMeter 来做接口性能测试,基于 RAP 等工具 Mock API 数据。可时不时我就会想:“要不要这么麻烦?有没有一款工具能够直接提供这些功能?经常在不同的工具之间切换来切换去真的很烦呢!”.
终于,我找到了一款集 API 设计、API 管理、API Mock、API 自动化测试的一体化协作平台 — Eolink Apikit!
1. Eolink Apikit 介绍
如果用一个公式来说明 Eolink Apikit,那么=API 管理 + Mock + 自动化测试 + 异常监控 + 团队协作
有了 Apikit,我们只需要定义接口文档就可以直接使用接口调试 & 测试、数据 Mock 等功能。并且,接口调试完成后即可保证和接口文档定义完全一致。高效、及时、准确!Apikit 主要提供了下面这 5 大功能:
- API 设计
- 文档管理
- 自动化测试
- 监控、研发管理
- 团队协作
如果用一句话描述,就是 Eolink Apikit 可以让API管理变得更简单!
2. 功能特性
2.1 快速生成和管理所有 API 文档
无论您使用什么语言开发,Apikit 都可以帮您统一规范地管理起来,并提供强大的文档管理、协作、测试、分享功能。
亮点有:
- 自动生成 API 文档,并支持动态更新通过注解自动生成 API 文档,并通过 OpenAPI 实现动态更新;一键导入 Swagger、Postman、JMeter、RAP、YAPI 等产品数据;通过界面快速创建 API 文档,支持导入各类数据报文直接生成文档内容;
- 首创的版本管理、差异对比、变更通知,让 API 文档真正可用!让您像管理代码一样管理文档版本,并能快速对比版本,了解版本变动。当 API 发生变更时可自动通知相关人员,让内外部人员快速了解 API 变更情况,降低沟通成本;
- 多协议支持,HTTP、Websocket、gRPC、SOAP、TCP、UDP 等
2.2 智能且强大的 Mock 帮助您高效对接
前端团队可以在 API 还没开发完成的情况下,借助 Mock API 实现预对接,加速开发进程。测试团队可以通过 Mock API 解耦不必要的系统,完成集成测试
- 根据 API 文档自动生成 Mock API ,系统自动根据请求参数返回不同的结果,支持随机生成返回数据,能够真实地模拟后端 API;
- 支持 MockJS 和 Javascript 语法,可随机生成返回数据,可随机生成各类返回数据:UUID、身份证、手机号、文本、时间、地址等。或者自行编写 Javascript 对请求参数和返回结果进行处理;
- 强大的自定义请求校验与响应,便于前后端对接和集成测试等场景 如果自动生成的 Mock API 无法满足需求,Apikit 还提供了高级 Mock:设置某些请求参数作为触发条件并返回对应的结果。让 Mock API 有了更广泛的使用场景,比如更真实地模拟后端来完成集成测试;
2.3 零代码自动化测试
Apikit 提供了 API 测试功能,支持自动生成测试数据,能够通过 Javascript 对请求报文、返回结果等进行加解密、签名等处理;提供强大、易用的企业级 API 自动化测试解决方案,5 分钟快速上手,提高 95% 以上回归测试效率,人人皆可使用的 “零代码” 自动化测试平台;
- 通过 API 文档创建测试流程,可插入数据库操作和 Javascript 脚本纯界面操作 5 分钟快速上手;自动生成随机测试数据;支持管理多个测试环境,一键切换;支持操作数据库,实现增删查改和验证数据;
- 将测试结果保存为测试用例,方便随时复用
- 一键进行回归测试,减少 95% 重复劳动!
- 提供详细的测试报告,包括返回头部、返回结果、性能时间分析等内容
3. 下载使用
访问 Apikit 的官网地址:https://www.eolink.com/apikit
既可下载对应操作系统的安装包,也可使用 Web 版,并且支持多种登陆,非常方便。
4. 快速上手
4.1 外观设置
当然,你可以选择自己喜欢的主题,Apikit 很贴心地内置了多款主题
4.2 添加项目
在 Eolink Apikit 中添加项目会让人十分愉悦,因为太方便了。
你可以批量导入项目,Eolink Apikit 支持一键导入 Swagger、Postman、RAP、YAPI 等产品数据,旧项目迁移一键搞定,爽到飞起!
4.3 创建文档
Apikit 中一共有 5 种创建 API 文档的方式:
- 新建 API 文档,也是最常用的 API 文档创建方法
- 导入 API 文档
- 从模板添加 API 文档
- 自动生成 API 文档
- IDEA 插件注释同步 API 文档
自动生成 API 在 API 管理应用 / 选中某个项目 / 其他菜单 / 数据源同步(API 文档自动生成),可以通过配置数据源信息,实现基于数据源的 API 信息自动生成 API 文档。当前支持 5 种数据源:Swagger URL、apiDoc、Github、gitlab、码云。
4.4 在线分享 API 文档
您可以在线分享项目给团队以外的人,其他人可以通过分享链接在线查看 API 文档并且进行 API 测试。通过这种方式查看 API 文档不需要注册账号,用户可方便查看接口文档和测试接口。在项目内,点击进入项目管理菜单,选择 在线分享,即可启用或禁用项目在线分享功能。
你也可以设置访问密码,确保只有密码才能查看,还可设置分享项目可见页面,用于控制外部人员通过链接访问时可查看的项目页面,系统默认可见全部。
分享完成之后,就可以通过链接在线访问了!高效,便捷,再也不用通过本地文档传输了!
还有其他功能,包括接口设计、接口调试、Mock API 等,都非常强大,强烈建议前往 https://www.eolink.com/?utm_source=cpsf&utm_content=cpy102去探索
总结
从上面我对 Eolink Apikit 的功能描述就可以看出,Apikit 已然是一款十分优秀的国产软件了,根据 Eolink Apikit 团队公开产品 Roadmap ,还有很多精彩的功能在开发中。
我相信Eolink Apikit 一定可以,而且每个中国的开发者都应该用一用 Apikit!