接口调试,是我们每个后台开发,在日常工作中必不可少的一步,一个好的工具能让我们的开发效率事半功倍。相信不少的小伙伴跟我一样再进行API调试时一直在使用Postman。它的接口调试功能虽然强大,但是诸多研发常用功能并不符合国人习惯(如:生成接口文档等)。虽然支持协同功能,但几乎是天价,同时由于服务器在国外,经常出现延迟甚至卡顿的情况,十分不稳定。
前段时间在北京出差的过程中,有个同做后台的开发的同事看到我在用Postman“轰”接口,他开玩笑的说了句 “什么年代了还用Postman”,成功勾起了我的好奇心,通过了解我知道了一款国产API调试工具ApiPost。
那么今天博主就带领大家从0到1(所谓的0到1就是从下载安装到上手)客观的测评一下我们国人自已开发的API调试工具。
什么是ApiPost
ApiPost = 接口调试+接口文档快速生成+接口文档规范化管理+Mock API+接口流程测试。
ApiPost产生的初衷是为了提高研发团队各个角色的效率!产品的使用受众为由前端开发、后端开发和测试人员以及技术经理组成的整个研发技术团队。ApiPost通过协作功能将研发团队的每个角色整合打通。
官网地址:https://www.apipost.cn?token=aa1116507a26160f8889861932e51455
Web版地址:https://console.apipost.cn/register?token=aa1116507a26160f8889861932e51455
客户端下载链接:https://www.apipost.cn/download.html?token=aa1116507a26160f8889861932e51455
注:ApiPost在使用时可以选择Web版(在线使用)与客户端版(需下载),本文为了更好的进行测评仅为大家演示客户端版的几个常用操作使用流程。
下载安装客户端
点击上方客户端下载地址进行跳转,也可以进入官网进行下载。下载时根据自身电脑的配置选择即可。
下载完成后选择自已对应的路径进行安装
安装完成后展现给我们的就是一个这么一个控制台,主题采用白字黑底配色,大致的功能已经给我们列出在首页了,下面我带领大家体验一下。
测评一:系统页面
不知道大家是否跟我一样,下载好一个东西都喜欢配置一些个性化的设置,对于一个页面整洁功能展示清晰的系统会比较有好感。下面我们来看下ApiPost这方面做得怎么样。
首先打开的时候是深色模式,右下角是一些个性化设置,对应的功能有,精简模式,控制台,上下分屏,新窗口打开响应区,模式调节,缩放,设置以及检查更新功能。
左侧列表,为项目目录,可以将不同的接口放入不同的包中,右侧的控制台占屏幕的5/4。整个为接口的调试区,整个排版清晰得体。这块做的真心挺不错的。
最左侧为七个主要的大功能页签,通过切换页签实现不同的功能。
正上方则是一些全局参数,常用Cookie,环境的变量的配置与使用。
剩下的这两块就是关于团队相关的了,平常自已用的话,完全可以不登录使用,但是如果整个团队使用时就需要进行登录了,后面我们会详细讲解,这里左侧圈中的为切换团队选项卡,右侧圈中的为日志,个人信息,同步协作,系统消息等相关功能。
测评一总结:系统的整个排版,颜色搭配,整体来说还是比较不错的,相比postman来说,我们的ApiPost没有很多多余的功能,很适合我们国人理解去使用。
测评二:基础功能
我们在使用这类软件的时候,归根结底就是为了对写好的接口进行测试。其他的功能都是附加功能,第二项我们来测评一下ApiPost的基础功能。
这里ApiPost为了让我们更好的上手,给我们提供一组示例接口。
点击接口后,右侧会弹出该接口的详信息,主要看下图中的几点,我们在新建一个接口的时候可以声明该接口是否开发成功,并可以对该接口进行一些说明,这些说明成功保存后也都会在下图中展示出来。
点击发送按钮后,我们可以清楚的再下面看到一些响应信息(包含:请求头,响应头,cookie…等)也可以以不同的形式去展现响应结果。为了方便我们看接口的性能右下角还为我们展示了响应码,以及接口的响应时间等等。
为了方便我们去看响应,还可以使用上文中提到的,新窗口打开响应区功能。
值得注意的是这里,这里弹出的时候,需要再次点击发送后才能看到
测评二总结: 这里我们只发送了一个请求进行演示,并没有做过多的操作是因为这些基本的操作(如:删除接口,新增一个接口等等),所有的工具基本的流程都是一致的,只要掌握了一个其它的都没太多问题。如果这些操作都不能理解,那也没关系ApiPost还为我们提供了一份详细的使用文档以及视频教程
小伙伴们可以通过我上文中贴出来的官网链接进行访问学习。如果连这么详细的文档和视频都看不懂,也没关系。我们Apipost还为小伙伴们提供了问答社区以及博客。
这一点说真的,Apipost做的还是挺赞的!当然所有的东西都没有绝对完美,在测试使用的过程中,我也发现,当我们使用新窗口打开响应区的时候,不能把当前请求的响应结果绑定到新的窗口上,窗口也不能居中显示,我有一瞬间还以为自已的操作有问题呢。这里是个可优化的点,这也仅是我的个人意见,希望官方未来能给我们用户带来更好的体验!
测评三:亮点功能
每个系统都会有自已的特色,通过官网的信息我们了解到,ApiPost的特色功能大致为,文档分享,多人实时协作,客户端不登录使用,脱机工作,参数库描述,Websocket测试等。
生成文档
文档是我们接口调试后需要开发人员编写的,这也是最令人头疼的事情之一,ApiPost也刚好为我们解决了这个问题, 尤其对于很多接口来说,假如每次都需要手动录入,将会是一件非常耗时、低效的事情。
假如我们想把上方测试的接口写成到接口文档中,我们就可以使用ApiPost的一键文档生成功能。
生成时我们可以只针对一个包乃至一个项目为单位进行分享查看
生成的文档相对我们平常自已写的文档来说还是更规范一些,完美避开了我们日常写错参数,大小写等问题,并且在分享的过程中还可以定义有效时间以及权限控制。团队中的前端人员也可以根据该文档去进行联调,完全省去了开发人员自已编写文档以及引用swagger等生成文档的框架等繁琐步骤。最最重要的一点是他特别特别的方便。不知道大家有没有发现在描述别的功能的时候总是进行很多操作,描述文档的时候他的整个过程十分简单,真真正正的实现了一键导出即使用!
实时协作
实时协作作为该平台的另一亮点之。一个项目组中包含了产品,测试,前端,后端,运维。ApiPost开发这个功能的核心本质就是针对团队打造的。
所有人都可以以项目组员的身份通过邮箱邀请,加入进来。由项目经理统一授权管理。
在对产品经理,测试,运维等,不需要涉及开发的人员可以设置只读权限,针对我们前后端开发,我们所做的每一步操作,在我们ApiPost中都可以做到实时更新(比如我在项目中新建了一个接口另外的同时哪里立马就会进行同步)。这样可以有效的解决协作不同步时带来的数据保存冲突问题。另外我们ApiPost还会实时对你的操作进行记录,无法追溯变更记录等问题。在我们ApiPost中都是不存在的。(下图为我在别人工程里面新建了一个包他那边立马就进行了同步了)
参数库描述
参数库描述是配合我们基础调试功能使用的,很多接口往往具有大量相同名称、相同意义的参数。就拿我们最常用的page,token来说。假如我们需要查询一个列表是不是需要传一些分页参数,再比如我们需要获取到当前的登录用户,我们就需要传一个token。这些参数往往在很多地方都有使用。我们就可以如下图一样把他定义为全局的Header或全局Body在输入参数时ApiPost还支持自动填充描述。这样以来我们就不用每次使用都要重新编写!节省了我们不少重复录入参数描述的时间。
离线使用
相信做开发的小伙伴有不少在政府部门,或是在一些相对机密的公司进行办公。他们往往都需要使用局域网开发。ApiPost也发现了这一点,所以我们在测试的过程中特地关闭了网络连接。
经过测试,ApiPost的绝大部分功能都可以再不登陆的情况下完成。即使你的电脑连网络都没有依旧不会造成太大的影响。
总结
整体的基础功能测试基本完成了,一篇两篇文章很难描述一个东西的好,只有大家自已安利使用了,才能知道这个东西适合不适合自已。在我看来ApiPost作为后起之秀,目前的基本功能都做的挺不错的(在这我只做了部分测试大家下去可以自行体会)也正如官网所说,他是更懂中国人的平台。未来还有很多可发展的空间,大家可以跟我一起见证ApiPost的崛起。