前言
- 降本增效一直是企业在不断追求不断提高的目标;
- 随着微服务成为各个互联网的标配,大家在享受微服务带来的便利的同时,也引入了一些痛点,比如:一个项目可能需要几十个上百个应用协作配合,其中可能涉及到成百上千个API;
- API的管理逐渐成为开发,联调,测试中的痛点问题;此时一个好用的API管理工具必然会极大的提高大家的工作效率;之前在做技术内部提效时,一直在寻找更好的API工具的路上;
痛点&解法&管理&玩转
API研发和联调时痛点
总结下之前我们团队在API方面遇到痛点问题:
- 开发团队使用多个API工具(Yapi,Swagger,Postman,自研等),多个工具之间数据难以打通;
- API文档编写繁琐、设计不规范、缺乏统一文档格式等;
- 缺乏版本管理,API变更没有通知;
- 测试人员难以维护测试用例,大量使用脚本的方式写自动化测试,学习、编写和维护的成本都很高
Apipost如何解痛点
- DTDD(文档与测试驱动开发)
- 形成标准文档,让各个团队(开发,测试,运维)协作有迹可循
- 用测试结果,推动项目进度,团队沟通更加通畅,项目管理可量化
API管理之路
-
起初在用Swagger进行接口管理,但是发现它在调式功能方面非常弱 -
后来就加上Postman做接口调试,Postman的Mock功能比较弱,同时团队人数比较多接口来回导入导出非常麻烦;而且Swagger网页和Postman来回切也比较费劲;新增加接口或接口参数变更同步给其他人十分麻烦; -
一直在寻找一款更好的API管理工具;皇天不负有心人,在一次偶然的浏览中看到了Apipost,通过其官网**https://www.apipost.cn?token=171e2f70f67756057b69b64aae3b41f3** 了解到 ApiPost = 接口调试+接口文档快速生成+接口文档规范化管理+Mock API+接口流程测试 即 Apipost=Swagger+Postman+Mock; -
Apipost正是能解我们现在的痛点,于是我自己进行了试用,在短短十几分钟试用后,我就对它爱不释手;经过一段时间的深度使用后我发现不仅后端研发,针对前端研发,测试人员以及技术经理都非常实用,可以极大提高团队的协作效率; -
以下列举我使用过的API相关工具对比
工具 | 实时接口文档 | 调试 | Mock | 是否支持Websocket测试 | 是否支持数据导入 | 是否支持生成程序代码 | 团队实时协作 | 项目权限管理 |
---|
Swagger | 实时 | 弱 | 弱 | 不支持 | 不支持 | 不支持 | 实时在线 | 无 | Postman | 无 | 强 | 弱 | Beta版 | 只支持导入 | 不支持 | 需要来回分享麻烦 | 无 | Yapi | 手工录入 | 较弱 | 弱 | 不支持 | 支持导入 swagger, postman, har 数据格式 | 不支持 | 实时在线 | 有 | Apipost | 在线接口文档,且支持分享 | 强 | 强 | 6.1版本及以上支持 | 支持多文件格式导入 | ApiPost支持生成NodeJS、Ajax等常见前端程序同时提供后端主流语言代码自动生成功能 | 实时在线且支持多人实时协作 | 有 |
带你玩转Apipost
真香
- 对于多年从事大型互联网老兵来说,是否是一个用心打磨过的好产品,是否好用,一- 上手便知;Apipost是真的香;总结如下:
- 不仅提供了基础的接口调试功能,而且具备文档共享贴心功能,同时还为我们提供了更加强大的脚本录制;更是站在团队管理的角度具备非常实用的团队管理及项目管理功能;
- 而且非常多的功能十分走心,比如我发现其中一些实用功能:
- 业务测试场景化:一个业务线需要N个接口相互依赖,通过接口间传参完美解决;
- 利用预执行脚本发送一个请求:之前经常遇到一种场景需要将请求结果绑定到变量,然后在当前接口的请求参数中使用这个变量,完美实现;
- 数据备份还原:再也不用担心数据丢失,以及多设备间数据共享问题;
- 响应结果分屏:在遇到大的入参请求时再也不用上拉下拉,极大提升了工作空间;
- 私有部署:再也不用担心数据安全,及网络问题;
还有非常多的功能,赶紧来解锁吧:
发送API请求
- api请求
- api响应
API活文档
-
之前经常听到过这种抱怨
- 系统烂的和屎一样,文档都是错的,开发人员都换了N波了,根本没法维护!!!
- 敏捷开发不是不在文档上浪费太多时间吗?怎么我还需要不断的去写文档,更新文档,而且没人看,浪费时间!
- 编写文档是一件很无聊的事情!
- 文档不保持最新,常常会产生误导,使得大家认知更加混乱!
… - 一线开发工作者各种吐槽文档,无法实时更新,无法很好的与人共享;于是出现很多工程提效团队去做文档优化,我自己也见过很多开源的以及公司内部使用的,总体来说都在易用性上,共享等各个方面差些意思;直到遇见Apipost,完美解决我自己遇到以及听同事反馈的所有难用的地方;接下来为大家详细介绍下如何生成API文档以及分享给其他人
-
分享API文档 -
打开分享连接
进阶玩法-脚本
-
脚本实现功能
- 测试(断言)请求返回结果的正确性(后置脚本)
- 动态修改接口请求参数,如增加接口签名参数等(前置脚本)
- 接口请求之间传递数据(使用脚本操作变量)
- 脚本中可以直接请求一个接口地址
-
预执行脚本 -
后执行脚本 -
发送结果
更多功能
文章篇幅有限更多好用的功能,欢迎大家自己体验并在评论区交流
总结
- 工欲善其事必先利其器
- 现在是大规模合作的年代,专业的人做专业的事;有了Apipost这么好用专业工具我们应该快速学习熟练使用它,大大提高我们的生产效率,没必要再去花时间再去自研API管理工具
|