在开发过程中，对 API 进行测试是非常重要的一步。我们需要保证这些接口在不同情况下都能够正常工作，并且能够应对异常情况。在 NodeJS 开发中，我们可以使用 Mocha 和 Supertest 进行 API 测试。本文将详细介绍如何使用 Mocha 和 Supertest 进行 API 测试，并给出最佳实践。
Mocha 和 Supertest 简介
- Mocha：JavaScript 测试框架，支持异步测试和简单断言库。Mocha 测试运行器可以在浏览器和 Node.js 中运行。
- Supertest：Super-agent 配合测试框架使用。Supertest 是一个基于 Super-Agent 的库，用于测试 Node.js HTTP 服务器。
安装 Mocha 和 Supertest
在开始使用 Mocha 和 Supertest 之前，我们需要先安装它们。在项目的根目录下，打开终端，执行以下命令即可：
npm install mocha supertest –save-dev
API 测试的最佳实践
1. 为每个 API 编写一个测试用例
每个 API 接口都应该有一个对应的测试用例，测试用例中需要覆盖所有的情况和异常情况。测试用例应该包括以下内容：
- 能够成功调用 API 并返回正确结果。
- 传入不同的参数，测试 API 的不同行为和可能的错误情况。
- 测试返回结果的格式是否正确。
- 测试所有可能的错误情况，包括参数错误，数据格式错误等等。
下面是一个简单的测试用例示例：
-- -------------------- ---- -------
------------- -------------- -- -- -
---------- ------ --- --- ---- ------ ---- ----- ---- ----- --------- ---- -- -
------------
------------------------------
------------
---------- ---- -- -
-- ----- ------ ---------
------------------------------------
---------------------------------------
------
--
--
---------- ------ --- ---- ----- ---- ------- --------- ---- -- -
------------
------------------------------------
------------ -----
--
---------- ------ --- ---- ----- ---- --- ----- --------- ---- -- -
------------
---------------------------------
------------ -----
--
--2. 使用 before 和 after 函数
before 函数用于在测试用例执行前，执行相应的初始化操作，例如数据库连接，创建测试数据等。after 函数用于在所有测试用例执行完成后，执行相应的清理操作，例如删除测试数据，断开数据库连接等。下面是一个示例代码：
-- -------------------- ---- -------
------------- ------ -- -- -
--- ---
--------- -- -
-- -------
--- - ---------
-----------
--
-------- -- -
-- ------
-- ---
--
------------- -------------- -- -- -
-- ----
--
------------- --------------- -- -- -
-- ----
--
--3. 使用 describe 和 it 函数
describe 函数用于描述当前测试的场景，it 函数用于描述具体的测试用例。在 describe 中可以嵌套多层 it 函数，用于描述更细节的测试用例。
-- -------------------- ---- -------
------------- ------ -- -- -
------------- -------------- -- -- -
---------- ------ --- --- ---- ------ ---- ----- ---- ----- --------- ---- -- -
-- ----
--
---------- ------ --- ---- ----- ---- ------- --------- ---- -- -
-- ----
--
--
-------------- -------------- -- -- -
---------- ------ - --- ---- --- ------ ----- ---- -- -
-- ----
--
--
--4. 使用 beforeEach 和 afterEach 函数
beforeEach 函数表示在每个测试用例执行前，先执行某些操作，例如每个测试用例执行前都要清空数据库。afterEach 函数表示在每个测试用例执行后，执行相应的操作，例如每个测试用例执行后都要关闭数据库连接。下面是一个示例代码：
-- -------------------- ---- -------
------------- ------ -- -- -
--- ---
------------- -- -
-- ------------
-- ---
--
------------ -- -
-- -------------
-- ---
--
------------- -------------- -- -- -
---------- ------ --- --- ---- ------ ---- ----- ---- ----- --------- ---- -- -
-- ----
--
--
-------------- -------------- -- -- -
---------- ------ - --- ---- --- ------ ----- ---- -- -
-- ----
--
--
--5. 使用 describe.only 和 it.only 函数
describe.only 和 it.only 函数用于只测试某个测试用例，可以避免无关测试用例的干扰。例如，我们只想测试 POST /api/v1/user 接口：
-- -------------------- ---- -------
------------------ ------ -- -- -
------------- -------------- -- -- -
---------- ------ --- --- ---- ------ ---- ----- ---- ----- --------- ---- -- -
-- ----
--
--
------------------- -------------- -- -- -
---------- ------ - --- ---- --- ------ ----- ---- -- -
-- ----
--
--
--6. 使用 after 函数中的回调函数
在 after 函数中，可以添加一个回调函数作为参数，在所有测试用例执行完成后执行。这个回调函数可以用于释放占用的资源，例如上传的文件、连接的数据库等等。
-- -------------------- ---- -------
------------- ------ -- -- -
---------- -- -
-- ----
-- ---
------
--
------------- -------------- -- -- -
---------- ------ --- --- ---- ------ ---- ----- ---- ----- --------- ---- -- -
-- ----
--
--
-------------- -------------- -- -- -
---------- ------ - --- ---- --- ------ ----- ---- -- -
-- ----
--
--
--示例代码
下面是一个使用 Mocha 和 Supertest 进行 API 测试的示例代码。
app.js
-- -------------------- ---- ------- ----- ------- - ------------------ ----- ---------- - ---------------------- ----- ------ - ------------------- ----- --- - --------- -------------------------- ------------------ ------- -------------- - ---
routes.js
-- -------------------- ---- -------
----- ------- - ------------------
----- ------ - ----------------
--- ----- - -
- -------- -- ----- ------- --
- -------- -- ----- ------- --
- -------- -- ----- ------- --
-
------------------- ----- ---- -- -
----- ------- - ---------------------------
----- ---- - ------------ -- --------- --- --------
-- ------- -
------ ---------------------- -------- ----- --- ------- --
-
--------------
--
-------------------- ----- ---- -- -
----- - ---- - - --------
-- ------- -
------ ---------------------- -------- ----- -- ---------- --
-
----- ------- - ------------ - -
------------ -------- ---- --
---------------------- -------- ---- --
--
-------------------- ----- ---- -- -
-- ---
--
-------------- - ------test.js
-- -------------------- ---- -------
----- ------- - --------------------
----- ------ - ----------------------
----- --- - ----------------
------------- ------ -- -- -
--- -------
----------- -- -
------------- -- -
------
--
--
---------- -- -
------------ -- -
------
--
--
------------- -------------- -- -- -
---------- ------ --- --- ---- ------ ---- ----- ---- ----- --------- ---- -- -
------------
------------------------------
------------
---------- ---- -- -
-- ----- ------ ---------
------------------------------------
---------------------------------------
------
--
--
---------- ------ --- ---- ----- ---- ------- --------- ---- -- -
------------
------------------------------------
------------ -----
--
---------- ------ --- ---- ----- ---- --- ----- --------- ---- -- -
------------
---------------------------------
------------ -----
--
--
-------------- -------------- -- -- -
---------- ------ - --- ---- --- ------ ----- ---- -- -
------------
---------------------
------- ----- ---------- --
------------
---------- ---- -- -
-- ----- ------ ---------
------- - ----------------
------------------------------------------
------
--
--
---------- ------ --- ---- ---- -- --- ---------- ---- -- -
------------
---------------------
---------
------------ -----
--
--
------------- --------------- -- -- -
-- ---
--
--总结
使用 Mocha 和 Supertest 进行 NodeJS API 测试的最佳实践，在于为每个 API 编写一个测试用例，并对测试用例进行分类和排序。测试用例中需要覆盖所有情况和异常情况，并在测试用例前后进行初始化和清理操作。在测试中使用 before 和 after 函数用于在测试用例前后进行操作。使用 describe 和 it 函数对测试用例进行分类和排序，并使用 beforeEach 和 afterEach 对测试用例进行初始化和清理操作。在测试结束时使用 after 函数的回调函数，对资源进行释放。在进行测试时，使用 Supertest 发送请求，并使用 expect 函数断言返回结果。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/65b77292add4f0e0ff000e28