简介
在前端开发中，我们经常需要与后端服务器进行数据交换。为了更好地测试和验证 API 接口的正确性，可以使用一些测试工具来帮助我们进行接口测试。其中一个比较方便实用的工具就是 api-easy。
api-easy 是一个基于 Node.js 的 API 测试框架，它提供了一套完整的 API 测试套件，可以帮助我们快速编写 API 测试用例，并检查 API 接口的响应结果是否符合预期。本文将详细介绍如何使用 api-easy 进行前端 API 接口测试。
安装
使用 npm 安装 api-easy：
npm install api-easy --save-dev
快速上手
以下是一个简单的 api-easy 测试用例示例，它会发送一个 GET 请求到指定的 API 接口地址，并检查返回值是否包含指定的关键字：
-- -------------------- ---- -------
--- ------ - ------------------
--- ------- - --------------------
--- ----- - -------------------- --- -----
--- ---- - ------------------------
---------------
-----------------
------------
--------------- ------ ------- ------------- ---- ----- -
------------------------------------- ----
--
----------------以上示例代码首先引入 api-easy 和 Node.js 的内置模块 assert。然后通过 APIeasy.describe() 方法来创建一个测试套件，设置 API 接口主机地址为 http://localhost:3000。
紧接着我们发送一个 GET 请求到 /api/user 接口，并期望返回状态码为 200。最后使用 .expect() 方法来检查响应结果是否符合预期。
API
describe(name)
创建一个新的测试套件。
name: 测试套件名称。
APIeasy.describe('测试套件名称');use(url)
设置 API 主机地址。
url: API 主机地址。
suite.use('http://127.0.0.1:3000');get(path)
发送一个 GET 请求到指定路径。
path: API 接口路径。
suite.get('/api/user');post(path)
发送一个 POST 请求到指定路径。
path: API 接口路径。
suite.post('/api/user');put(path)
发送一个 PUT 请求到指定路径。
path: API 接口路径。
suite.put('/api/user');del(path)
发送一个 DELETE 请求到指定路径。
path: API 接口路径。
suite.del('/api/user');expect(status[, body])
检查响应结果是否符合预期。
status: HTTP 响应状态码。body: 预期返回值。可以是一个字符串、正则表达式或回调函数。如果是回调函数，参数为err、res和body。
suite.expect(200);
suite.expect(404, 'Not Found');
suite.expect(500, /Internal Server Error/);
suite.expect(function(err, res, body) {
assert.ifError(err);
assert.equal(res.statusCode, 200);
assert.ok(body.indexOf('user') !== -1);
});addBatch(batch)
向测试套件中添加一个测试批次。
batch: 测试批次名称和测试用例数组。每个测试用例包含了一个或多个请求和断言操作。
-- -------------------- ---- -------
----------------
--------- -
----- --- -
------ ---------- -
--- ---- - --------------
----------------------------------- ------
--
----- -- ------ ------------- ---- ----- -
--------------------------------- ---
-
--
----- --- -
-----
- ----------------------------------------------------------- --------
----------------------------------------------------------------------------------