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

面试官：小伙子，你的代码为什么这么丝滑？

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

RESTful API 是构建 Web 应用程序和服务的关键组件之一。使用 Node.js 平台上的 Express.js 和 MongoDB，可以轻松地构建功能强大、高效和可伸缩的 RESTful API。

本文将介绍如何使用 Express.js 和 MongoDB 构建 RESTful API，包括以下内容：

  1. 建立项目和安装依赖

  2. 连接 MongoDB 数据库

  3. 创建 CRUD API

  4. 使用中间件处理请求

  5. 错误处理

  6. 单元测试

  7. 建立项目和安装依赖

首先，创建一个新的 Express.js 项目并安装所需的依赖项：

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

这里，我们使用了 Body-parser 中间件来处理请求正文，并使用 Mongoose 来操作 MongoDB 数据库。

  1. 连接 MongoDB 数据库

在项目根目录下创建一个 config 目录，并在其中创建一个 db.js 文件：

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

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

这里，我们指定了 MongoDB 数据库的 URL。接下来，在 app.js 文件中连接到数据库：

-- ------

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

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

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

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

-- ------

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

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

这里，我们使用 Mongoose.connect() 方法连接到 MongoDB 数据库，并使用 Promise 进行异步处理。然后，我们使用 Body-parser 中间件来处理请求正文，并启动 Express.js 服务器。

  1. 创建 CRUD API

现在，我们可以开始定义 RESTful API 的路由和处理程序。

首先，我们需要为我们的数据模型创建 Mongoose 模式。在 models 目录下创建一个 user.js 文件：

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

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

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

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

这里，我们定义了一个名为 User 的模式，其中包含姓、名和电子邮件属性。

接下来，我们可以创建处理程序来处理用户资源的 CRUD 操作。在 controllers 目录下创建一个 user.js 文件：

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

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

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

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

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

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

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

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

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

这里，我们定义了一个名为 User 的控制器，其中包含处理程序来执行用户资源的 CRUD 操作。

  1. 使用中间件处理请求

在处理程序之前，我们可以定义一个中间件函数，用于验证用户 ID 是否有效。在 middleware 目录下创建一个 validate-id.js 文件：

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

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

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

这里，我们使用 Mongoose.Types.ObjectId.isValid() 方法验证用户 ID 是否有效。

接下来，在 app.js 文件中使用中间件处理程序：

-- ------

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

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

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

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

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

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

这里，我们使用 app.get()、app.post()、app.put() 和 app.delete() 方法定义资源路由，并使用中间件 validateId 处理程序以确保用户 ID 是有效的。

  1. 错误处理

在处理程序和中间件中，可能会发生错误。我们可以定义错误处理程序来处理这些错误，并发送适当的 HTTP 响应。

在 app.js 文件中定义错误处理程序：

-- ------

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

这里，我们使用 app.use() 方法定义一个错误处理程序，并发送适当的 HTTP 响应。

  1. 单元测试

最后，我们可以编写单元测试来测试我们的路由和控制器。在 test 目录下创建一个 user.test.js 文件：

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

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

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

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

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

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

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

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

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

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

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

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

这里，我们使用 Supertest 测试框架和 jest 进行单元测试，并执行所有用户资源的 CRUD 操作。

结论

通过使用 Express.js 和 MongoDB，我们可以轻松地构建功能强大、高效和可伸缩的 RESTful API。在本文中，我们介绍了如何建立项目和安装依赖项、连接到 MongoDB 数据库、创建 CRUD API、使用中间件处理请求、错误处理和单元测试。这为我们的项目提供了一些指导和启示，帮助我们更好地构建和维护我们自己的 API。

来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/6709c6d2d91dce0dc87b93ea

阅读全文

猜你喜欢

  • Promise 如何处理嵌套回调函数的问题？

    背景： 在前端开发中，回调函数常常被使用来处理异步操作。但是，当存在大量异步操作的时候，回调函数嵌套的层数会非常深，这样不仅难以阅读，而且还容易出现BUG，给代码的维护带来非常大的困难。

    10 天前
  • CSS Grid 布局中常见的 5 个错误及解决方案

    介绍 在前端开发中，CSS 布局扮演了非常重要的角色，而 CSS Grid 布局则是其中的一个重要部分。CSS Grid 布局提供了一种新的方式来实现网站的布局，提供了更高效、更灵活的方式来设计和排版...

    10 天前
  • Sequelize 中如何使用 TransactionManager 实现数据事务操作

    在实际的应用开发过程中，数据库操作是非常常见的一项任务。而在某些特定场景中，需要将多个数据库操作作为一组操作来执行，这时我们需要使用到事务(transaction)。

    10 天前
  • 从传统 API 过渡到 GraphQL 的成功故事

    随着互联网技术的不断发展，传统的 API 设计已经逐渐无法满足现代应用的需求。GraphQL 作为一种新的 API 设计方式，已经被越来越多的前端开发者所采用。 本文将介绍一个从传统 API 过渡到 ...

    10 天前
  • 深入理解 ES6 字面量手动实现 Symbol

    JavaScript 是一门伟大的语言，但在 ES5 版本之前，它仅支持字符串和数字作为对象属性名，这使得在开发中为新属性名分配唯一值变得非常麻烦。由于这个原因，Symbol 在 ES6 中被引入，它...

    10 天前
  • Angular 中的路由懒加载（Lazy Loading）

    在开发单页面应用程序时，路由是不可或缺的一部分。在应用程序中使用路由，可以使用户在导航时流畅地运行，并且还可以优化应用程序的加载速度。然而，随着应用程序变得越来越复杂，路由的数量也会变得越来越多。

    10 天前
  • 详解 Deno 的权限管理机制

    Deno 是一个新兴的 JavaScript 运行时环境，它是由 Node.js 的创始人 Ryan Dahl 所创建的，与 Node.js 相比，Deno 做了一些不同的尝试，其中比较显著的就是“安...

    10 天前
  • 使用 Fastify 和 GraphQL 构建 API

    前端开发者需要掌握各种技术来构建应用程序。在 Web 应用程序中，构建可伸缩和高性能 API 是至关重要的。Fastify 是一个快速、轻量、易于使用，并且底层使用 Node.js 构建的 Web 框...

    10 天前
  • 如何用 Enzyme 对 React 样式组件进行测试

    如何用 Enzyme 对 React 样式组件进行测试 React 是一个广泛使用的前端框架，而 Enzyme 是一种用于 React 组件测试的 JavaScript 测试工具，它可以非常方便地测试...

    10 天前
  • Mocha 在浏览器中的使用方法及注意事项

    Mocha 是一种流行的 JavaScript 测试框架，它支持在浏览器上进行单元测试和集成测试。本文将详细介绍如何在浏览器中使用 Mocha 进行测试，并提供一些注意事项，以便您正确地使用它进行测试...

    10 天前
  • 搭建 Headless CMS 的成本分析与技术选型

    前言 Headless CMS 是一种新兴的 CMS 架构模式，他将原本紧密耦合的页面展示和数据管理进行分离，使得平台可以灵活地对数据进行管理，并通过 API 接口向不同的客户端提供数据，包括 Web...

    10 天前
  • Serverless 如何集成安全认证

    Serverless 如何集成安全认证 随着云计算的快速发展，Serverless 成为了一种越来越流行的架构方式。与传统的基于服务器的架构相比，Serverless 架构具有更高的可扩展性，更低的维...

    10 天前
  • 关于 ES7 中的对象展开运算符详解

    在现代前端开发中，ES7 中的对象展开运算符被广泛使用，它可以方便地将对象或数组中的属性或元素展开并与其他对象或数组合并。本文将深入探讨对象展开运算符的使用方法、注意事项以及示例代码，并为读者提供指导...

    10 天前
  • Web Components—— 你的组件库可否成为 “姐妹花”

    前言 在现代 Web 开发中，组件化已经成为了最流行的技术趋势之一。为了方便地复用和维护代码，许多前端工程师都会开发自己的组件库。然而，随着应用程序规模不断扩大和复杂性增加，组件之间的依赖关系变得越来...

    10 天前
  • 在 ECMAScript 2020 中使用 try {} catch {} 代替 try { } catch(error) { }

    前言 在 JavaScript 中，我们经常使用 try...catch 来处理异常。在过去的版本中，我们通常这样使用： --- - -- ---- ---- - ----- ------- - ...

    10 天前
  • 如何最大化 GraphQL 的成本效益

    GraphQL 是一种在现代 Web 开发中越来越流行的查询语言。它为前端开发者提供了一种更加灵活和高效的方式来获取数据，并且与现有的 API 和数据源无缝集成。但是，GraphQL 的成本效益并非自...

    10 天前
  • 如何在响应式设计中处理导航栏的布局

    在如今多种设备类型的情况下，响应式设计已经成为了设计师和开发者们必须掌握的技能之一。 而对于导航栏这样经常使用到的组件来说，如何在响应式设计下做到既美观又实用，无疑就成为了一个很重要的问题。

    10 天前
  • Deno 中如何优雅地处理错误

    前言 Deno 是一个用 Rust 和 TypeScript 构建的新一代 JavaScript 运行时环境，自 2020 年 5 月发布以来备受关注。与 Node.js 相比，Deno 具有更好的安...

    10 天前
  • Server-Sent Events 简介及实现轮询的局限性

    介绍 Server-Sent Events（SSE）是一种 Web 技术，它允许服务器向客户端推送实时数据，无需客户端主动请求。服务器可以随时向客户端发送消息，并在客户端的浏览器上进行处理。

    10 天前
  • 如何使用 Material Design 风格的 Checkbox 控件

    介绍 Material Design 是一种由 Google 开发的现代化设计语言，用于 Android、Web 和桌面应用程序的设计。Material Design 旨在创造更具可见性、层次结构性和...

    10 天前

相关推荐

    暂无文章