用 Fastify+Sequelize 实现 RESTful API 的完整实例

阅读时长 13 分钟读完

RESTful API 是现代 Web 开发中最常用的 API 架构之一,因其简单、通用、易于扩展的特点而备受推崇。在本文中,我们将介绍如何使用 Fastify 和 Sequelize 并结合它们的强大功能来实现 RESTful API 的完整实例。

快速介绍 Fastify

Fastify 是一个高效、低开销且极快的 Web 框架,它建立在 Node.js 之上。其出众的性能得益于其对 Node.js 的异步 I/O 和流处理能力的最大化利用,同时其内建支持大多数流行的安全和验证功能。

我们将使用 Fastify 来实现我们的 RESTful API,由于它具有出色的快速性和灵活性,可以帮助开发人员快速构建和测试其 API 服务。

快速介绍 Sequelize

Sequelize 是一个支持多种数据库的 ORM(Object-Relational-Mapping)库,它使得通过 Javascript 方式访问数据库变得简单易用。它存储定义和关系,映射到数据库表的结构,并实现高级查询等常见的数据库操作。

我们将使用 Sequelize 来操作我们的数据库,其优点之一是其支持多种数据库类型,包括 MySQL、PostgreSQL、SQLite 和 Microsoft SQL Server(MSSQL)。允许我们根据需求或环境选择适合的数据库。

提供的 API

在开始探索这个完整实例之前,我们需要了解我们将要构建的 API 服务所提供的特征。本实例提供的 API 如下:

  • 创建一个新的用户
  • 确认指定 ID 的用户
  • 获取所有用户
  • 更新指定 ID 的用户
  • 删除指定 ID 的用户

步骤 1 - 初始化项目

首先,我们需要准备好项目的基础结构。在终端或命令行中,创建一个新目录,并在其中初始化一个新的 Node.js 项目。使用以下命令执行操作。

以上命令将为您创建一个新的 Node.js 项目,并自动生成 package.json 文件。下一步是安装所需的依赖文件。我们需要安装以下依赖:

  • Fastify - 用于实现 API 服务
  • Sequelize - 用于操作数据库
  • mysql2 - 用于访问 MySQL 数据库

运行以下命令安装以上依赖:

在本文中,我们将使用 MySQL 数据库,因此也安装了相应的驱动程序 mysql2。这些依赖项将自动添加到 package.json 文件中。

步骤 2 - 配置数据库的连接

接下来,我们需要配置数据库的连接。在项目的根目录中,创建一个名为 .env 的新文件。我们使用 dotenv 这个插件来载入 .env 文件中的环境变量。在 .env 文件中添加以下内容:

以上内容需要替换你的数据库访问信息。我们将使用以下代码将该文件的内容加载为当前环境变量。

接下来,我们使用 Sequelize 创建一个新的连接池。连接池是一个维护和管理到数据库的连接的机制。它是一种处理大量并发请求但并不会消耗过多开销的方式,我们稍后会用到它.

-- -------------------- ---- -------
----- - --------- - - ---------------------

-- ------ ---
-- ---------------------------------------- - --

----- --------- - --- ------------------------------ -------------------- ------------------------ -
  ----- --------------------
  -------- --------
  -------- ------
  ----- -
    ---- --
    ---- --
    ----- -----
  --
  --------------- -
    ---- -
      -------- -----
      ------------------- -----
    -
  -
---

以上代码使用 Sequelize 的 Sequelize() 构造函数创建一个新的数据库连接。通过传递我们上一步在 .env 文件中定义的环境变量来建立这个连接,最终得到了一个连接池。

步骤 3 - 创建 User 模型

在开始开发 API 之前,我们需要创建一个用户模型。以下是我们将要创建的 Sequelize 模型。

-- -------------------- ---- -------
----- - --------- - - ---------------------

----- ---- - ------------------------ -
  ---------- -
    ----- -----------------
    ---------- -----
  --
  --------- -
    ----- -----------------
    ---------- -----
  --
  ------ -
    ----- -----------------
    ---------- ------
    ------- ----
  --
  --------- -
    ----- -----------------
    ---------- -----
  -
---

-------------- - -----

在以上代码中,我们使用 Sequelize 中的 sequelize.define() 函数来定义一个 User 模型。模型有四个字段:firstName, lastName, email, 和 password。这些字段是必需的,不能为 nullemail 字段还具有一个唯一性约束。

步骤 4 - 处理 API 路由

接下来,我们将定义 API 的路由。Fastify 是一个高度灵活的框架,可以轻松地定义和管理路由。为了使用该框架,我们需要创建一个名为 app.js 的新文件。

-- -------------------- ---- -------
----- ------- - -------------------- ------- ---- ---
----- ---- - ------------------------------
----- ----- - -------------------------------

------------------------------------------

-------------------------------------------- -
  ------------ -----
  ------------ --------
  -------- -
    ----- - ------ -------- --------- ---- -
  -
---

--------------------- ------ -- -
  ---------------------
---

----- ----- - ----- -- -- -
  --- -
    ----- -------------------------
    ----- ------------
    ----- ------------------------------- -- ------
  - ----- ------- -
    -------------------------
    ----------------
  -
--

--------

在以上代码中,我们实例化 fastify,并通过 logger:true 来开启日志记录。然后我们引入创建的 User 模型。接下来,注册 Fastify 的路由管理插件 fastify-cors,以便与我们的服务进行跨域通信。

我们还注册了 Fastify 的 fastify-swagger 插件,该插件允许您使用 Swagger UI 查看和测试 API。我们为Swagger UI 提供了 /docs 路径,通过在浏览器中访问该路径,您可以看到完整的 API 文档。

最后,我们引入 users 路由中声明的路由并循环遍历它们,将路由注册到我们的服务中。

我们将对每个路由路径使用不同的文件,例如 userRoutes.js

-- -------------------- ---- -------
----- ---------- - ----------------------------------------------------
----- -------- - --------------------------------------------------
----- ---------- - ----------------------------------------------------
----- ---------- - ----------------------------------------------------
----- ------------- - -------------------------------------------------------

----- ------ - -
  -
    ------- -------
    ---- -------------
    -------- ----------
  --
  -
    ------- ------
    ---- -------------
    -------- --------
  --
  -
    ------- ------
    ---- -----------------
    -------- ----------
  --
  -
    ------- ---------
    ---- -----------------
    -------- ----------
  --
  -
    ------- ------
    ---- -----------------
    -------- -------------
  -
--

-------------- - -------

以上代码中我们将用户的相关路由划分到了不同的控制器中。每个控制器具有不同的功能,例如 createUser() 会创建新用户,而 allUsers() 会获取所有用户。

步骤 5 - 创建 UserController

在上一步中,我们定义了所有的路由,但是我们需要在 UserController 中实现这些路由的功能。以下是 UserController 的具体实现。

-- -------------------- ---- -------
----- ----------- - ----- ---- -- -
  ------ ----- ------------------
--

------------------ - ----- --------- ------ -- -
  --- -
    ----- ---- - ----- --------------------------
    --------------------------
  - ----- ------- -
    ---------------------
    ------------------
  -
--

---------------- - ----- --------- ------ -- -
  --- -
    ----- ----- - ----- ---------------
    -- ------------- --- -- -
      ------------ -------- --- ----- --- ---- ------- ---
    - ---- -
      ------------------
    -
  - ----- ------- -
    ------------------
  -
--

------------------ - ----- --------- ------ -- -
  --- -
    ----- ---- - ----- -------------------------------
    -- ------ -
      ----- ----------- - ----- --------------------------
      ---------------------------------
    - ---- -
      ------------ -------- --- ---- --- ----- -- ------ --- --- --------------------- ---
    -
  - ----- ------- -
    ------------------
  -
--

------------------ - ----- --------- ------ -- -
  --- -
    ----- ---- - ----- -------------------------------
    -- ------ -
      ----- ---------------
      ------------ -------- ----- -------------------- --- --------- ---
    - ---- -
      ------------ -------- --- ---- --- ----- --- --- --------------------- ---
    -
  - ----- ------- -
    ------------------
  -
--

--------------------- - ----- --------- ------ -- -
  --- -
    ----- ---- - ----- -------------------------------
    -- ------ -
      --------------------------
    - ---- -
      ------------ -------- --- ---- --- ----- --- --- --------------------- ---
    -
  - ----- ------- -
    ------------------
  -
--

在以上代码中,我们实现了所有在 userRoutes.js 中定义的路由,并将每个路由的功能定义为单独的函数。例如,createUser() 创建新用户,allUsers() 获取所有用户。

对于查询操作,我们使用 User.findAll() 查询整个用户列表,而对于单个用户查询,则使用 User.findByPk() 按 ID 查询用户。更新和删除操作也借助于 User.findByPk() 查找指定 ID 的用户,参考其返回值以进行更新或删除操作。

步骤 6 - 测试 API

现在我们已经实现了我们的 API,可以使用 Postman 或命令行测试它。您还可以使用 Swagger UI,该 UI 可用于测试 API 测试服务。 在浏览器中访问您先前指定的 Swagger UI 路径即可开始测试。

在测试期间,您可以使用任何创建和管理 MySQL 数据库的工具。我们最喜欢使用 phpMyAdmin 或 MySQL Workbench,但也可以使用像 sequelize-cli 这样的 Javascript 工具。

本文结论

本文介绍了如何创建具有完整 RESTful API 能力的 Fastify 和 Sequelize 应用程序。我们查看了如何创建一个用户模型、如何实现路由、如何定义功能并进行测试。 Fastify 和 Sequelize 为开发人员提供了一个强大、灵活的工具链,使其能够快速开发和测试卓越的 API 服务。

由于 Fastify 是一个不断更新和发展的框架,我们建议您阅读官方文档以了解有关其最新功能和更改的信息。与 Sequelize 一样,Fastify 的文档非常完整且易于阅读。

接下来,在您的项目中加入安全性和身份验证,如 JWT Token 将使您的 API 更加安全,更具可扩展性。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/670e02615f551281025f5bc7

纠错
反馈