本篇文章将介绍如何使用 Mocha、Chai 和 Sinon.js 测试 Node.js RESTful API。在本文中，我们将通过一个示例 RESTful API 展示测试的基本流程和方法，同时深入探讨 Mocha、Chai、Sinon.js 的使用。
什么是 RESTful API？
RESTful API 是一种使用 HTTP 协议中的 GET、POST、PUT、DELETE 等请求方式来操作资源，遵循某些规则并符合 HATEOAS (Hypermedia As The Engine Of Application State) 定义的 Web Service 接口。它是一种符合 REST 架构风格的 API，可以实现跨平台和语言的通信。
为什么要测试 RESTful API？
测试是保障质量的重要一环，对于 RESTful API 也不例外。对于开发人员而言，保证 API 的正确性和可用性是非常关键的。RESTful API 的测试可以帮助开发人员在整个开发生命周期内发现和修复问题，提高开发效率，降低成本，同时还可以保证 API 的稳定性，提高用户体验。
Mocha、Chai、Sinon.js 简介
Mocha 是 Node.js 环境下的一个测试框架，支持异步操作、并发测试、多种报告格式等。相比其他测试框架，Mocha 可以实现更为清晰和有条理的测试代码书写。
Chai 是一个 BDD/TDD 断言库，它可以和任何 JavaScript 测试框架实现无缝结合。它提供了多种风格和语法的断言函数，方便开发人员进行自定义和扩展。
Sinon.js 是一个基于 spy、stub 和 mock 等模式的功能强大的 JavaScript 测试库。它提供了模拟 Ajax 请求、模拟函数行为的能力，使得测试更加全面和真实。
示例代码
我们将使用一个示例 RESTful API 来演示接口测试的过程。这个 API 是一个简单的用户管理系统，包含 GET、POST、PUT、DELETE 等基本操作。我们将使用 Mocha、Chai、Sinon.js 来测试各种情况的正确性。
-- -------------------- ---- -------
-- ------
----- ------- - -------------------
----- ---------- - -----------------------
----- --- - ----------
---------------------------
--- ----- - -
- ----- -- ------- -------- ------ -- --
- ----- -- ------- ------ ------ -- --
- ----- -- ------- ---------- ------ -- -
--
--------------------- ----- ---- -- -
----------------
---
------------------------- ----- ---- -- -
----- ---- - ------------ -- ---- -- ---------------
-- ------- -
-------------------------- --- ---------
-------
-
---------------
---
---------------------- ----- ---- -- -
----- ---- - ---------
-- --------- -- ---------- -- ---------- -
----------------------------- ---- --------
-------
-
-----------------
---------------
---
------------------------- ----- ---- -- -
----- ---- - ------------ -- ---- -- ---------------
-- ------- -
-------------------------- --- ---------
-------
-
--------- - --------------
-------- - -------------
---------------
---
---------------------------- ----- ---- -- -
----- --------- - ----------------- -- ---- -- ---------------
-- ---------- - -- -
-------------------------- --- ---------
-------
-
----------------------- ---
--------------------
---
-------------- - ----编写测试
首先，我们需要创建一个测试文件 test.js，在该文件中撰写测试代码。
引入依赖
我们需要引入我们前面介绍的测试库，并将 app.js 中的主模块 app 导入进行测试。
const mocha = require('mocha');
const chai = require('chai');
const expect = chai.expect;
const sinon = require('sinon');
const app = require('./app');编写测试用例
我们来编写测试用例，测试 GET 和 POST 请求的正确性。
-- -------------------- ---- -------
-------------- --- --- ---- ---------- ---------- -
------- ------------ -------------- -
-----------------
------------------
------------------ ---- -
--------------------------------
-----------------------------------
---------------------------------------
-------
---
---
-------- ------------ -------------- -
-----------------
-------------------
---------- -- ----- ------- ---- ----
------------------ ---- -
--------------------------------
------------------------------------
------------------------------------------
-------
---
---
---这个测试用例主要测试 GET 和 POST 请求的正确性。我们模拟 GET 请求并检查返回结果是否符合预期，模拟 POST 请求并检查返回数据是否正确。
运行测试
我们可以在终端中运行测试命令（需要自行安装 Mocha 和 Chai 库）：
$ mocha --exit --timeout 10000 test.js
使用 Sinon.js 进行测试
我们现在需要使用 Sinon.js 来测试 PUT 和 DELETE 请求的正确性。在这之前，我们需要引入 Sinon.js 库和一个测试数据。
const sinon = require('sinon');
const userData = { id: 1, name: "Alice", age: 30 };我们可以引入 userData 对象，表示一个要进行测试的用户数据。
测试 PUT 请求
我们先测试 PUT 请求的正确性，我们需要模拟 PUT 请求，并检查返回结果是否符合预期。我们使用 Sinon.js 的 stub 方法模拟 PUT 请求，代码如下：
-- -------------------- ---- -------
-------------- --- --------- ---------- -
------- ---------------- -------------- -
-- -- ---- ------ ---- ---- ---- ---- --- ----
----- ---- - ---------------------------- ---- -- -
----- ---- - - ----------- --
------- - --------------
--------- - --------------
-------- - -------------
---------------
---
-----------------
--------------------
------------ -------- ---- ----
------------------ ---- -
--------------------------------
------------------------------------
-------------------------------------------
-----------------------------------
-------------------------------------
---------------
-------
---
---
---在这个测试中，我们模拟 PUT 请求，并使用 stub 方法模拟模拟 server 响应的数据。我们检查返回值是否符合预期，最后使用 restore 方法将原始方法恢复。
测试 DELETE 请求
我们接下来测试 DELETE 请求的正确性，我们需要模拟 DELETE 请求，并检查返回结果是否符合预期。我们使用 Sinon.js 的 spy 方法模拟 DELETE 请求，代码如下：
-- -------------------- ---- -------
-------------- ------ --------- ---------- -
---------- ---------------- -------------- -
----- --- - --------------- ---- -- -
--------------------
---
-----------------
-----------------------
------------------ ---- -
--------------------------------
----------------------------------
--------------
-------
---
---
---在这个测试中，我们模拟 DELETE 请求，并使用 spy 方法模拟模拟 server 响应的数据。我们检查返回值是否符合预期，最后使用 restore 方法将原始方法恢复。
总结
在本文中，我们介绍了如何使用 Mocha、Chai 和 Sinon.js 测试 Node.js RESTful API，同时演示了一个基本的测试示例。Mocha 提供了一种清晰有条理的测试框架，Chai 提供了多种语法和风格的断言函数，Sinon.js 提供给了我们 spy、stub 和 mock 等强大的测试工具。
测试 RESTful API 的重要在于保证 API 的正确性和可用性。测试可以帮助开发人员及时发现问题并修复错误，提高开发效率，降低成本，同时也可以保证 API 的稳定性，提高用户体验。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/64925b9348841e9894025c22