开始 API 接口测试之前,我们需要弄清接口测试的含义:

接口测试就是根据接口清单,模拟客户端向服务端发送请求数据,并获取响应数据后,查看响应数据是否符合预期的过程。

整个过程可以分为三个步骤:

第一步:模拟客户端向服务端发送请求;

第二步:接受服务端返回的数据;

第三步:查看返回数据是否符合预期。

必须要明确的一点是,接口测试的依据是接口清单,接口清单的依据是API文档,API文档的依据的项目需求文档和原型图。有了接口清单后,针对于每一个接口依次执行上述三个步骤的过程就是接口测试。

那么是怎么执行的呢?因为接口测试是在程序开发过程中进行的,是没有完整的程序的,所以测试是需要用到工具的。不仅模拟客户端向服务端发送请求是需要工具的,从服务端接受数据也是需要工具的,而且有时候验证返回数据是否符合预期也是需要用到工具的。

这就不得不提到在接口测试中常用的如fiddler之类的抓包工具、postman、Jmeter等工具了。但这里我会推荐另一款更符合国人需求的开源 API 工具——Eoapi.

下面我会用 Eoapi 演示,如何进行 API 接口测试:

在测试中我们可能会关注状态码、响应体以及响应时间,这些数据 Eoapi 通通都会展示给你,判断 API 是否正常。

api 连接yarn api接口教程_API

 

开始测试之前,我们需要先填写测试数据~,可以点击标签页的加号新建一个测试标签页。

api 连接yarn api接口教程_测试工具_02

 

还可以通过点击分组 API 的闪电图标快速对某个 API 发起测试。

api 连接yarn api接口教程_API_03

 

通过类比现有的知识去学习新的知识往往更快,平时我们一般会在浏览器里看 API 请求信息,这些信息在 Eoapi 对应的位置是什么呢?相信通过下面的对照图你很快能知道如何在 Eoapi 测试:

下划线颜色相同代表相同模块

api 连接yarn api接口教程_api 连接yarn_04

 

请求 URL/请求方式/请求头/Query 参数

API Path 里面可能填写了 Query 参数,Eoapi 会将它自动同步到 Query 参数的表格里面。

首先确认你的 HTTP 请求体格式,选择相应的请求体格式后点击测试按钮。

api 连接yarn api接口教程_测试工具_05

 

就可以看到相应 API 响应信息啦!

api 连接yarn api接口教程_websocket_06

 

通过点击测试历史,还可以回溯当时测试的所有 API 请求信息,快速回归测试。

api 连接yarn api接口教程_测试工具_07

 

tips:由于该软件一直在维护当中,所以可能现版本截图跟本文中略有差异。

目前这款软件已经更新到 v1.9.0了,除了我们常说的接口测试、接口文档、接口管理以及Mock 功能,新增团队协作、API 分享功能。除此之外他们还支持:

  • 丰富的插件市场,可拓展
  • 前后置脚本
  • 支持查看所有测试历史
  • 支持 Websocket 协议,后续也会新增支持更多的主流协议

在线 Demo:

https://www.eoapi.io/?utm_source=cs&utm_campaign=xh&utm_content=ceshi

api 连接yarn api接口教程_程序人生_08

 

如果你觉得这个开源项目还可以的话,不妨点个 star 支持下他们,如果你觉得还需要继续优化,不妨去提个Issue.