开发者的瑞士军刀,目测要火!
共 2266字,需浏览 5分钟
· 2022-05-31
降本增效是企业追求的永恒目标。
如今,前后端分离早已成为互联网的标配,大家在享受这种开发模式带来的便利同时,也体会到一些痛点,比如:
一个需要几十个、上百个应用协作配合的项目,其中可能涉及到成百上千个API——API的管理逐渐成为开发、联调、测试中的痛点问题。
API研发和联调时存在的痛点:
开发团队使用多个API工具 (Postman、Yapi、Swagger等),多个工具之间数据难以打通; API文档编写繁琐、设计不规范、缺乏统一文档格式等; 缺乏版本管理,API变更没有通知; 测试人员难以维护测试用例,大量使用脚本的方式写自动化测试,学习、编写和维护的成本都很高。
痛点解决路径:
DTDD(文档与测试驱动开发) 形成标准文档,让各个团队(开发,测试,运维)协作有迹可循 用测试结果,推动项目进度,团队沟通更加通畅,项目管理可量化
API管理之路
起初我们用Swagger进行接口管理,但是发现它在调式功能方面非常弱,就加上Postman做接口调试,然而Postman的Mock功能比较弱,同时团队人数比较多,接口导入导出非常麻烦,且Swagger网页和Postman来回切也比较费劲,新增加接口或接口参数变更同步给其他人十分麻烦。
此时,一个好用的API管理工具会极大提高大家的工作效率,在做技术内部提效时,我们一直希望寻找到更好的API管理工具,随后锁定Apipost。
官网地址:https://www.apipost.cn/?utm_source=10099
官网介绍,ApiPost = 接口调试+接口文档快速生成+接口文档规范化管理+Mock API+接口流程测试;即:Apipost=Swagger+Postman+Mock;
Apipost恰好能解我们现在的痛点,于是我自己进行了试用,在短短十几分钟试用后,就对它爱不释手,经过一段时间的深度使用后,发现Apipost不仅适合后端研发,前端研发,测试人员以及技术经理使用也会非常容易上手,极大提高了团队的协作效率。
以下,通过列举对比我使用过的API相关工具:
![](https://filescdn.proginn.com/a85c5eb94a33416e7220fcec1ce3f0ba/33b3fbebcdeff34a72730fece7488914.webp)
带你玩转Apipost
对于多年从事大型互联网老兵来说,是否是一个用心打磨过的好产品,是否好用,一上手便知;Apipost是真的香!总结如下:
不仅提供了基础的接口调试功能,而且具备文档共享贴心功能,同时,还为我们提供了更加强大的脚本录制,更是站在团队管理的角度具备非常实用的团队管理及项目管理功能,而且非常多的功能十分走心,比如:
1)业务测试场景化
一个业务线需要N个接口相互依赖,通过接口间传参完美解决;
2)利用预执行脚本发送一个请求
之前经常遇到一种场景,需要将请求结果绑定到变量,然后在当前接口的请求参数中使用这个变量。Apipost支持使用类似下面的脚本轻松实现:
apt.variables.set("token", response.json.token); // token 是接口返回字段
注:response.json是json格式的响应结果。
3)数据备份还原
再也不用担心数据丢失,以及多设备间数据共享问题;
4)响应结果分屏
在遇到大的入参请求时再也不用上拉下拉,极大提升了工作空间;
5)私有部署
再也不用担心数据安全,及网络问题;
还有非常多的功能,赶紧来体验解锁吧!
Web版链接(不用下载)
https://console.apipost.cn/register?utm_source=10099
客户端下载地址:
https://www.apipost.cn/download.html?utm_source=10099
Apipost实操
发送API请求
![](https://filescdn.proginn.com/1134090f94e10ed81e9863af40ca999d/7e054c945e848563e169463ef4a0ed79.webp)
API活文档
之前经常听到抱怨:系统烂得和屎一样,文档都是错的,开发人员都换了N波了,根本没法维护!!!
敏捷开发不是不在文档上浪费太多时间吗?怎么还需要不断去写文档、更新文档?而且没人看,浪费时间!
编写文档是一件很无聊的事情!
文档不保持最新,常常会产生误导,使得大家认知更加混乱!
一线开发工作者各种吐槽文档无法实时更新,无法很好地与人共享。于是出现很多工程提效团队去做文档优化,我自己也见过很多开源的以及公司内部使用的,总体来说都在易用性上、共享等各个方面差些意思,直到遇见Apipost,完美解决了我自己遇到以及听同事反馈的所有难用的地方。
接下来为大家详细介绍下如何生成API文档以及分享给其他人。
分享API文档
![](https://filescdn.proginn.com/d97866f58d0f3e85b5ac911a52538cfc/ddd25caba3f1f7ca4b2b7a06635093fa.webp)
打开分享连接
![](https://filescdn.proginn.com/c13d2c9057357e0bc52864fb8fd17794/466ca0a0048ff288885c18295226fcb5.webp)
进阶玩法-脚本
脚本实现功能
测试(断言)请求返回结果的正确性(后置脚本) 动态修改接口请求参数,如增加接口签名参数等(前置脚本) 接口请求之间传递数据(使用脚本操作变量) 脚本中可以直接请求一个接口地址 预执行脚本
![](https://filescdn.proginn.com/afb9d1599d225fad040d6198cf06a6a7/a36fa44b0335022f476017041b96f2b1.webp)
后执行脚本
![](https://filescdn.proginn.com/30029189d4c4e63f5061e9651b9d84c6/ccb00e2f5b17326766188e645919d643.webp)
发送结果
![](https://filescdn.proginn.com/9d4efdbec6fbd8b4cb1bdf98b2057bf9/effa5f499759c50c4932807f78e259a1.webp)
更多功能
文章篇幅有限更多好用的功能,欢迎大家亲自体验并扫码加入官方企业微信社群进行交流。
Web版链接(不用下载)
https://console.apipost.cn/register?utm_source=10099
客户端下载地址:
https://www.apipost.cn/download.html?utm_source=10099
总结
工欲善其事必先利其器。当下是大规模合作的时代,专业的人要保证足够的精力做专业的事。既然有了Apipost这么好用且专业的工具,我们就应该快速地学习并熟练地使用它,从而大大提高我们的工作效率,完全没有必要再去花时间去自研API管理工具。
注:本文作者目前就职于阿里巴巴专注于Java、大数据及人工智能;致力于用技术改变生活。