RESTful API 是现代 Web 应用的重要组成部分。它提供简单、可靠和可扩展的方式来访问和管理应用程序数据。Fastify 是一个快速和低开销的 Web 框架，而 MongoDB 是一个流行的文档型 NoSQL 数据库。在本文中，我们将探讨如何使用这两个技术构建一个 RESTful API。
前置条件
在继续之前，您需要满足以下前置条件：
准备工作
我们将从创建一个新的 Node.js 应用程序开始。在您选择的工作目录内，运行以下命令：
npm init -y
这将创建一个 package.json 文件，其中包括项目的名称、版本、描述等详细信息。接下来，我们将安装以下依赖项：
npm install fastify fastify-cors fastify-mongodb
这将安装 Fastify、Fastify-CORS 和 Fastify-MongoDB 模块。
设置应用程序
现在，我们将编写一些代码来设置应用程序，包括连接到 MongoDB 数据库和启动 Fastify 应用程序。
-- -------------------- ---- -------
-- ------
----- ------- - -------------------- ------- ---- ---
----- ---- - ------------------------
----- ------- - ---------------------------
-----------------------
------------------------- -
----------- -----
---- ----------------------------
-- ---------
--------- -------
---
---------------- ----- ------ -- -
------------ -------- ------ ------- ---
---
----- ----- - ----- -- -- -
--- -
----- ---------------------
------------------- ------- -- ---- -------
- ----- ----- -
-------------------
----------------
-
--
--------在上面的代码中，我们启动一个 Fastify 应用程序，并向其添加 Fastify-CORS 和 Fastify-MongoDB 插件。然后，我们创建一个简单的路由，返回 "Hello World!"。最后，我们使用 listen 方法在端口 3000 上启动服务器。
现在，如果您运行 node app.js，您将能够通过 http://localhost:3000 访问我们的应用程序，并看到返回的消息。然而，我们还没有使用 MongoDB 构建 RESTful API。
构建 RESTful API
我们将创建一个简单的 RESTful API，允许我们执行以下操作：
- 获取所有项目
- 获取单个项目
- 创建项目
- 更新项目
- 删除项目
我们将使用 MongoDB 数据库来存储项目。
创建路由
我们首先需要创建一些路由来处理这些操作。在 app.js 文件中添加以下内容：
-- -------------------- ---- -------
-- ------
----- --------------- - -----------
-- ------
------------------------ ----- ----- ------ -- -
----- -------- - ----- --------------------------------------------------------------
------ ---------
---
-- ------
---------------------------- ----- ----- ------ -- -
----- - -- - - -----------
----- ------- - ----- ------------------------------------------------------ ---- ------------ ---
-- ---------- -
------ ---------------------- -------- -------- --- ------ ---
-
------ --------
---
-- ----
------------------------- ----- ----- ------ -- -
----- ------- - ---------
----- ------ - ----- ----------------------------------------------------------------
----- --------------- - ----- ------------------------------------------------------ ---- ----------------- ---
------ ----------------
---
-- ----
---------------------------- ----- ----- ------ -- -
----- - -- - - -----------
----- ------- - ---------
----- ------ - ----- -------------------------------------------------------- ---- ------------ -- - ----- ------- ---
-- --------------------- --- -- -
------ ---------------------- -------- -------- --- ------ ---
-
------ - -------- -------- ------- ------------- --
---
-- ----
------------------------------- ----- ----- ------ -- -
----- - -- - - -----------
----- ------ - ----- -------------------------------------------------------- ---- ------------ ---
-- -------------------- --- -- -
------ ---------------------- -------- -------- --- ------ ---
-
------ - -------- -------- ------- ------------- --
---在上述代码中，我们定义了五个路由处理函数，分别对应五个 RESTful 操作。对于每个路由处理程序，我们都使用 fastify.mongo.db.collection 方法从 MongoDB 中获取名称为 projects 的集合。然后我们使用 MongoDB 的 CRUD 方法来执行每个操作。请注意，我们使用 ObjectID 函数将字符串 ID 转换为 MongoDB ObjectId。
编写测试用例
现在，我们已经创建了 RESTful API，我们需要编写测试用例来确保它能按预期工作。在根目录下创建 test 文件夹，并在其中创建一个 api.test.js 文件。下面是测试用例代码：
-- -------------------- ---- -------
-- -----------
----- - ------------ -------- - - -------------------
----- - ----- - - ------------------
--------------- -- -- -
--- -----------
--- ---
--- ----
----- --------------- - -----------
--------------- -- -- -
---------- - ----- -------------------------------------------------
-- - ----- -----------------------
----- ------------------------------------------- -- ----
--- - ----------------- ----
----- ------------
---
-------------- -- -- -
----- -------------------
----- ------------
---
--------------- -- -- -
----- ------------------------------------------- -- ----
---
------------ ------ - --------- ----- -- -- -
----- ------- - -
----- -------- ---
------------ ----- -- ------- --
--
----- -------- - ----- ------------
------- -------
---- ------------
-------- -------
---
--------------------------------------
---------------------------------------
----- -------- ---
------------ ----- -- ------- --
---
---
------------ --- --- ---------- ----- -- -- -
----- -------- - -
-
----- -------- ---
------------ ----- -- ------- --
--
-
----- -------- ---
------------ ----- -- ------- --
-
--
----- ----------------------------------------------------
----- -------- - ----- ------------
------- ------
---- -----------
---
--------------------------------------
------------------------------------------------
---
------------ --- - ------- -- ---- ----- -- -- -
----- ------- - -
----- -------- ---
------------ ----- -- ------- --
--
----- - ----------- -- - - ----- --------------------------------------------------
----- -------- - ----- ------------
------- ------
---- -----------------
---
--------------------------------------
-----------------------------------------------
---
------------ ------ - ------- -- ---- ----- -- -- -
----- ------- - -
----- -------- ---
------------ ----- -- ------- --
--
----- - ----------- -- - - ----- --------------------------------------------------
----- -------- - ----- ------------
------- ------
---- ------------------
-------- -
----- -------- ---
------------ ----- -- ------- --
-
---
--------------------------------------
--------------------------------------- -------- -------- ------- ------------- ---
----- -------------- - ----- ---------------------------------------- ---- ------------ ---
--------------------------------------
----- -------- ---
------------ ----- -- ------- --
---
---
------------ ------ - ------- -- ---- ----- -- -- -
----- ------- - -
----- -------- ---
------------ ----- -- ------- --
--
----- - ----------- -- - - ----- --------------------------------------------------
----- -------- - ----- ------------
------- ---------
---- -----------------
---
--------------------------------------
--------------------------------------- -------- -------- ------- ------------- ---
----- -------------- - ----- ---------------------------------------- ---- ------------ ---
-----------------------------------
---
---在测试用例中，我们使用 Fastify Test Utils 来测试 RESTful API 中的每个操作。对于每个测试用例，我们首先准备一个数据库，并为每次测试重新创建一个空的集合。然后，我们使用 HTTP 请求（POST、GET、PUT、DELETE）向 API 发送请求，并断言响应结果是否是我们预期的。
运行测试
现在我们已经写好了测试用例，我们可以运行所有测试，确保我们的 API 可以按预期工作。在终端中运行以下命令：
npm test
如果所有的测试都通过了，那么我们现在已经成功地构建了一个 RESTful API，它使用 Fastify 和 MongoDB 来存储和检索数据。
总结
在本文中，我们学习了如何使用 Fastify 和 MongoDB 构建 RESTful API。我们首先创建了一个 Fastify 应用程序，然后向其添加了 Fastify-CORS 和 Fastify-MongoDB 插件。接下来，我们编写了一些路由来处理 CRUD 操作，并编写了测试用例以确保它们可以按预期工作。现在，您可以使用这套工具来创建高效且可靠的 RESTful API。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/648e5da348841e9894cb7b77