如何使用 Express.js 和 Firebase 构建 RESTful API

在现代 web 应用程序中,构建 RESTful API 已经成为了标配。Express.js 是一个强大而又流行的 Node.js Web 框架,Firebase 则是一个功能强大的后端服务平台。在本篇文章中,我们将介绍如何使用 Express.js 和 Firebase 构建 RESTful API,并提供一些示例代码来帮助您入门。

安装和初始化 Firebase

首先,您需要安装 Firebase 并创建一个新的 Firebase 项目。在 Firebase 控制台中,可以轻松地创建项目并为其分配一个项目 ID。然后可以使用 Firebase CLI 将该项目与本地环境连接起来。

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

运行 firebase init 命令时,您可以选择 Cloud Functions 和 Firestore 等组件。如果您只想使用 Firebase 认证和实时数据库,请选择相应的选项并按照向导完成所有步骤。

安装和初始化 Express.js

接下来,您需要安装 Express.js,并设置服务器以便将路由请求发送到正确的处理程序。在项目根目录中,使用以下命令安装 express 和 body-parser:

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

安装完成后,在 index.js 中添加以下代码:

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

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

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

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

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

运行 npm start 命令,您应该能够在 localhost:3000 上看到“Hello, world!”消息。

集成 Firebase

现在,您需要将 Firebase 与 Express.js 集成。在 index.js 中添加以下代码:

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

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

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

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

在上面的代码中,我们使用 Firebase 管理员 SDK 连接到服务端的 Firebase 项目。我们首先从 Firebase 控制台下载了服务端的 JSON 配置文件,并将其解析为服务凭证。之后,我们使用凭证对象和数据库 URL 初始化 Firebase 应用实例。

创建 REST API

现在我们已经初始化了 Express 和 Firebase,并准备好了将其集成。我们现在可以开始创建 RESTful API 了。

首先,我们创建一个路由处理程序,用于获取数据库中的所有项目,如下所示:

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

在上述代码中,我们使用 Firestore API 获取项目集合中的所有文档,并将它们转换为可序列化 JSON 结构。最后,我们向客户端发送响应消息。

现在,我们添加一个路由处理程序,用于获取指定 ID 的项目:

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

在上述代码中,我们使用集合的 ID 参数从 Firestore API 获取单个项目的文档。如果在数据库中找不到文档,则向客户端返回适当的错误消息。

最后,我们为我们的 REST API 服务器提供 POST 请求的路由,并存储新项目的信息:

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

在上述代码中,我们将请求主体中的数据提取为一个新项目,并通过 Firestore API 添加到集合中。最后,我们向客户端发送一个消息,指示新项目已成功添加到数据库中。

结论

以上是使用 Express.js 和 Firebase 构建 RESTful API 的最基本步骤。在现代 web 应用程序中,需要了解如何创建 RESTful API,以便构建与前端框架无关的可靠服务端代码。本文提供的示例代码可以帮助您了解 Express.js 和 Firebase 等技术服务的集成流程。值得注意的是,您可以使用这些技术构建大型应用程序,因为它们可以方便地扩展和优化以提高性能和安全性。

完整代码:https://github.com/xxx/xxx

来源:JavaScript中文网 ,转载请注明来源 本文地址:https://www.javascriptcn.com/post/672f50b0eedcc8a97c8dcf40