前言
最近在写自己的小Demo,是一个前后端分离的分布式项目,在开发阶段难免会遇到需要测试接口的时候,我用的是比较流行的PostMan接口测试工具,但是使用下来,发现这个工具测试一些学习的用例和小型项目是完全够用的,但是在玉带中大型项目的时候,尤其是多人开发的项目会有很大的弊端,功能总是不够完善。在步行街上找了一圈以后,发现了一个比较小众的好东西,好家伙,问了十几个开发的朋友,只有2个人知道:Apipost,她的官网在这里:https://www.apipost.cn/。他的很多功能确实让我眼前一亮,有一种,原来接口测试工具还可以这样设计的一种惊叹感。
简介
Apipost是一个接口调试 接口文档快速生成 接口文档规范化管理 Mock API 接口流程测试工具,说人话就是Apipost是全能的,可以协助前端、后端、测试、运维产品等多个人员的工作,使得协同开发效率更上一层楼。他立志于做一个更懂中国程序员的工具,果然中国人更懂中国人。
安装
Apipost提供了两种体验方式,一种是客户端,另一种是WEB网页端。
1️⃣WEB端
首先我们来体验一下WEB端。使用微信登录以后我们可以看到是这样的一个界面。
WEB端是有点类似的TAPD的一个团队项目管理,接下来我们来重点试试客户端。
2️⃣客户端
点击下载客户端,下载自己电脑对应的版本即可,我的电脑是Windows,所以我下载的是Windwos64位版本。安装过程属于无脑下一步的那种,我就不多赘述了。
大功告成!
安装好了,终于看到了庐山真面目。不得不说,这界面。作为一个程序员来说,还算挺可的,特别符合程序员的审美标准,不知道各位C友们怎么看?
我们来对比一下PostMan的界面,感觉PostMan上手学习成本更高,他的界面设计也更复杂,没有Apipost来的简单,对于我个人而言是更喜欢Apipost的设计风格,属于那种用了一次就会爱上他的感觉。
测试接口
我们首先来试试一个比较常用的功能:测试接口,他可以模拟发送HTTP请求,这个功能对于绝大多数的后端开发来说是不陌生的。 点击新建,我们发现提供的功能还挺全面的,不仅仅有接口测试,还支持测试WebSocket和创建文档等功能。
点击接口,我们就可以看到测试接口的工作区域了。我们可以看到,他的一个工作区域的排布是非常紧凑的,功能和数据是挺全的,不仅仅支持常见的查看Header、Body等,还真词汇导入导出参数等功能。
还有一个我很喜欢的小功能——接口说明。
他竟然还支持MarkDown的语法来写接口说明,这简直不要太友好了,把接口说明一些,前端一看到这美观的说明,这效率杠杠的。
我提前准备好了一个小接口来测试一下,还有一个小的地方挺贴心的,那就是不仅仅可以书写接口规范和说明,还可以告诉前端我这个接口的开发阶段,前端调用了我这个接口,如果发现了有BUG,可以马上修改状态进行反馈。
确定好url以及传的参数以后就可以点击发送,Apipost会模拟一次请求去请求后端接口。
我们可以看到,他返回的数据默认是会自动美化,省去我们还要再将返回的JSON拿去在线的JSON解析网站去解析了,点击开发上面的发送按钮还可以保存当前接口的进度,方便下次开发或者测试打开就可以直接使用,直接一步到位,比心。
尝试了一下测试接口的功能,我好好像漏了一步?我竟然不用登陆就可以使用?简直就是工作利器,我们公司是属于那种平时开发不给使用外网的,都是使用局域网开发,很多的工具没登录压根就不给使用。同时意味着如果你处于一个断网的状态,同样可以使用Apipost客户端进行大部分的操作,压根不会影响你的开发效率,这一点对于局域网开发者实在是太友好了。 PostMan虽然说也可以实现,但是很麻烦,尤其是一开始就要你登录,如果你赶时间的话就不得不登录去使用,很不友好。 这里还有一个小彩蛋,点击这里这里的生成代码按钮,可以生成多种语言url请求代码模板,包括C、Java、Python等,以后调用第三方的API再也不用去拼参数了。
✨核心亮点功能
生成文档是Apipost的另一个重要功能,接口文档的撰写非常麻烦,而且很多属于重复工作,效率低下。我们写接口文档一般会采用Swagger来自动生成接口文档,但是这个接口文档侵入性太强了,在代码里面要写大量的注解和配置,有没有一键就可以自动生成漂亮、规范的文档的软件呢? 有!Apipost提供了自动生成文档的功能,我们写好了接口以后,只需要点击一键分享按钮,就可以自动生成接口,并且可以自定义分享有效期及权限,这是绝大多数的接口文档生成工具做不到的。
1️⃣核心亮点功能
点击这个分享文档按钮即可生成在线的接口文档。
如果你的接口文档是不想公开的话是可以设置权限的,目前是可以通过密码去区分权限。
同时支持随机密码和自定义密码。如果你比较懒就随机密码,如果你比较精致,就自定义密码。
我们将这里的外网链接复制到浏览器中访问就可以看到美观的接口文档了。
他大致长这样,比Swagger美观和简洁很多。
如果你想要导出到本地的话,还可以以三种方式去导出,这个产品直接给满分好吧。
2️⃣参数库描述
在一般的前后端分离模式的开发中,前端如果想了解后端的参数的含义一般都是通过接口文档,所以这个时候接口文档的参数表达就显得格外重要了。Apipost支持给每个参数快速写一简单的注释,让前端在看到接口文档的时候可以快速知道这个参数所代表的含义。
添加了参数描述以后的接口文档就变得更健壮也更简洁易懂,十分契合团队协作开发。
不知道各位开发大佬有没有一种感觉,有些时候参数的描述是非常重复的,比如说username就表示登录的用户名,password就表示密码,很多的时候会重复写很多次,真的是很苦恼。Apipost提供了一个参数描述库的功能,对于一个填写过的参数,我们可以在新建接口可以通过点击参数描述后面的按钮快速导入描述,不用重复打字,对于已经填写过的参数,Apipost会自动匹配描述,不用重复填写。
对于一些常见的参数,我们可以把他们录入到参数描述库里面去,下次使用可以直接使用了。
我测试了几个接口下来,挺实用的,毕竟很多的时候参数名重复确实可以剩下不少的时间。
总结
整体体验下来,APIPOST我还是挺满意的,作为一款转为国人设计的软件,可以说是有挺多的亮点:
- 客户端脱机且无需登录也可以使用。
- 一键快速生成开发文档。
- 参数描述库的出现减少了很多机械重复工作
- 各种小细节(自动生成模拟代码、文档区分权限等)直接拉满。
- 等等
作为一款国产的API研发协同一体化平台,仅仅诞生两年,各方面功能和体验做的还是十分不错的,是一个后起之秀,他仅仅才2岁(诞生2年),未来还是有很大的修改和提升的空间,相信在未来,APIPOST会变成一款主流的软件。如果有小伙伴想体验一下的话可以直接点击下面的官网链接跳转:
- Apipost官网地址: Apipost官网地址:https://www.apipost.cn?token=1f1d0d70d294ad00bc3a57b53da771a6
- Web版链接(不用下载) Web版地址:https://console.apipost.cn/register?token=1f1d0d70d294ad00bc3a57b53da771a6
- 客户端下载地址: 客户端下载链接:https://www.apipost.cn/download.html?token=1f1d0d70d294ad00bc3a57b53da771a6