概述
REST API 是现代 Web 应用架构中必不可少的基础组成部分，对于前端开发者来说，如何对 REST API 进行测试是一个非常重要的技能。本文将介绍在 Express 应用中使用 Chai 和 Superagent 进行 REST API 测试的步骤，帮助开发者更好地理解如何进行测试。
环境
在开始本次实验之前，我们需要准备好以下环境：
- Node.js 10.x 或以上版本
- npm 包管理器
- Express 应用
安装
在执行测试前，我们需要安装 Chai 和 Superagent。在项目的根目录下，使用以下命令安装这两个库：
npm install chai superagent --save-dev
测试用例
接下来，我们将创建一个简单的 Express 应用，并使用 Chai 和 Superagent 进行测试。在这个应用中，我们将提供几个简单的 REST API，包括获取所有数据、获取单个数据和创建数据。同时，我们也将对这些 API 进行测试。
首先，我们需要创建一个 Express 应用实例，并监听端口：
-- -------------------- ---- ------- ----- ------- - ------------------- ----- --- - ---------- ----- ---- - ----- ---------------- -- -- - ------------------- -- --------- -- ---- ------------- --- -------------- - ----
接下来，我们添加获取所有数据的路由：
-- -------------------- ---- -------
-------------------- ----- ---- -- -
----- ---- - -
---- ---- ----- --------
---- ---- ----- --------
---- ---- ----- -------
--
---------------
---然后，我们添加获取单个数据的路由：
-- -------------------- ---- -------
------------------------ ----- ---- -- -
----- -- - --------------
----- ---- - -
---- ---- ----- --------
---- ---- ----- --------
---- ---- ----- -------
--
----- ------ - ---------------- -- ------- --- ----
-- -------- -
-----------------
- ---- -
------------------------- --------
-
---最后，我们添加创建数据的路由：
app.post('/api/data', express.json(), (req, res) => {
const data = req.body;
res.json(data);
});现在，我们的 Express 应用已经完成了，接下来是测试过程。
步骤
首先，我们需要在项目的根目录下创建一个测试文件夹，如 test。在 test 文件夹下，我们创建一个名为 api.test.js 的文件，用于存放测试用例。
在这个文件中，我们将导入 Chai 和 Superagent：
const chai = require('chai');
const expect = chai.expect;
const request = require('superagent');
const app = require('../app');然后，我们可以编写我们的测试用例。首先，我们可以测试获取所有数据的 API 是否正常运行：
-- -------------------- ---- -------
------------- ----------- -- -- -
---------- ------ --- --- -- ----- -- ---- --------- ------ -- -
------------------------------------------------ ---- -- -
-----------------------
---------------------------------
-----------------------------------
-------
---
---
---上面的测试用例使用 Superagent 的 get 方法对 /api/data 路由进行请求，并使用 Chai 的 expect 断言数据是否符合预期。使用 done 函数告诉 Mocha，这个测试用例已经执行完成。
接下来，我们测试获取单个数据的 API 是否正常运行：
-- -------------------- ---- -------
------------- --------------- -- -- -
---------- ------ --- --- - ---- -------- ------ -- -
-------------------------------------------------- ---- -- -
-----------------------
---------------------------------
------------------------------------
--------------------------------------- -----
----------------------------------------- --------
-------
---
---
---------- ------ --- -- ---- -- --- ------- ------ -- -
--------------------------------------------------- ---- -- -
-----------------------
---------------------------------
------------------------------ --------
-------
---
---
---上面的测试用例使用 Superagent 的 get 方法对 /api/data/:id 路由进行请求，并使用 Chai 的 expect 断言数据是否符合预期。其中，第二个测试用例用于测试数据不存在时是否能够返回正确的状态码。
接下来，我们测试创建数据的 API 是否正常运行：
-- -------------------- ---- -------
-------------- ----------- -- -- -
----- ---- - ---- ---- ----- --------
---------- ------ --- --- --- ------- ---- -------- ------ -- -
-------
--------------------------------
-----------
---------- ---- -- -
-----------------------
---------------------------------
------------------------------------
--------------------------------------- -----
----------------------------------------- --------
-------
---
---
---上面的测试用例使用 Superagent 的 post 方法对 /api/data 路由进行请求，并使用 Chai 的 expect 断言数据是否符合预期。数据来源于一个常量 data，包含 id 和 name 两个属性。
最后，我们需要在 package.json 文件中添加一个脚本命令，用于执行测试用例：
{
"scripts": {
"test": "mocha"
}
}现在，我们可以在命令行中使用以下命令执行测试：
npm test
总结
本文介绍了在 Express 应用中使用 Chai 和 Superagent 进行 REST API 测试的步骤。通过本次实验，我们可以更好地理解如何对 REST API 进行测试，并掌握使用 Chai 和 Superagent 进行测试的技巧。希望这篇文章对你有所帮助！
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6502b98895b1f8cacdff286b