Jest 是一个流行的 JavaScript 测试框架，它提供了一套简单易用的 API，使得编写测试变得更加容易和愉快。在本文中，我们将介绍如何使用 Jest 进行 API 测试，并提供一些示例代码和最佳实践。
安装 Jest
首先，你需要安装 Jest。你可以通过以下命令来安装 Jest：
npm install --save-dev jest
安装完毕后，你可以在项目中创建一个 __tests__ 目录来存放测试文件。Jest 会自动识别这个目录并运行其中的测试文件。
编写测试
在 Jest 中，一个测试文件通常包含多个测试用例（test case）。每个测试用例都是一个函数，它包含一些断言（assertion），用于验证被测试的代码是否符合预期。
以下是一个简单的测试用例示例：
test('adds 1 + 2 to equal 3', () => {
expect(1 + 2).toBe(3);
});在上面的例子中，我们使用 test 函数来定义一个测试用例。第一个参数是测试用例的描述，第二个参数是测试用例的实现。在这个测试用例中，我们断言 1 + 2 的结果应该等于 3，如果不等于，则测试失败。
Jest 提供了许多断言函数，用于比较不同类型的值。例如，toBe 用于比较原始值和对象引用，toEqual 用于比较对象或数组的值。你可以在 Jest 文档 中找到所有可用的断言函数。
测试 API
现在，我们已经了解了如何编写测试用例。接下来，我们将看看如何使用 Jest 测试 API。
在测试 API 时，我们通常需要使用一个 HTTP 客户端库来发送请求。在这里，我们将使用 axios 库。你可以通过以下命令来安装它：
npm install axios
假设我们要测试的 API 是一个获取用户信息的端点，它的 URL 是 /api/users/:userId，其中 :userId 是用户的 ID。该端点返回一个 JSON 对象，包含用户的姓名、年龄和电子邮件地址。
以下是一个测试该端点的示例代码：
-- -------------------- ---- -------
----- ----- - -----------------
--------- ---- ------ ----- -- -- -
----- -------- - ----- ----------------------------
----------------------------------
-------------------------------
----- ----- -----
---- ---
------ ----------------------
---
---在上面的代码中，我们首先导入 axios 库。然后，我们定义了一个测试用例，用于测试 /api/users/123 端点的返回值。我们使用 await 来等待 axios.get 函数的返回值，并使用 expect 函数进行断言。
在这个测试用例中，我们断言 HTTP 响应的状态码应该是 200，并且响应的数据应该等于一个包含用户信息的对象。
模拟 HTTP 请求
在编写 API 测试时，我们通常需要模拟 HTTP 请求的响应，以便测试不依赖于外部服务。在 Jest 中，我们可以使用 jest.mock 函数来模拟 HTTP 客户端库的行为。
以下是一个使用 jest.mock 函数模拟 HTTP 请求的示例代码：
-- -------------------- ---- -------
----- ----- - -----------------
-------------------
--------- ---- ------ ----- -- -- -
-----------------------------
------- ----
----- -
----- ----- -----
---- ---
------ ----------------------
-
---
----- -------- - ----- ----------------------------
----------------------------------
-------------------------------
----- ----- -----
---- ---
------ ----------------------
---
---在上面的代码中，我们首先使用 jest.mock 函数来模拟 axios 库。然后，我们使用 mockResolvedValue 函数来模拟 axios.get 函数的返回值。最后，我们执行了一个与之前相同的测试用例，用于测试模拟的响应是否符合预期。
结论
在本文中，我们介绍了如何使用 Jest 进行 API 测试。我们了解了如何编写测试用例、使用断言函数、发送 HTTP 请求和模拟 HTTP 响应。我们还提供了一些示例代码和最佳实践，希望能够帮助你更好地理解 Jest 和 API 测试。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6742f84f99516187ace12191