使用 Express.js 和 Mongoose 构建 RESTful API 的完整指南

面试官：小伙子，你的数组去重方式惊艳到我了

在现代网络开发中，RESTful API 已经成为构建被动性和高扩展性应用程序的标准方法之一。这种技术为我们提供了一种用于处理数据通信的简单，可伸缩和可复用的机制，这对前端开发人员来说非常有用。在本文中，我们将深入探讨如何使用 Express.js 和 Mongoose 构建 RESTful API，包括代码示例和最佳实践。

什么是 RESTful API？

RESTful API 是一种用于建立 Web 应用程序的架构风格，它使用 HTTP 协议来执行 CRUD（增加、读取、更新、删除）操作，这些操作直接针对 Web 开发所使用的数据源进行。RESTful 规定了如下四个原则：

  1. 使用统一的资源标识符（URI）来标识互联网资源，例如 https://api.example.com/users/123。
  2. 通过 HTTP 方法（GET、POST、PUT、DELETE 等）来定义针对资源的操作。
  3. 返回内容的表述形式和内容的本身是分离的，例如 JSON、XML 或 HTML 等格式。
  4. 消息应该是无状态的，这意味着，必须包含有关客户端操作的所有信息。

构建 RESTful API 的常用工具

Express.js 是一个广泛使用的 Node.js 框架，提供了可用于构建 Web 应用程序所需的许多实用功能。通过 Express.js，我们可以轻松构建 RESTful API，并轻松管理路由，中间件和异常处理。

Mongoose 是 MongoDB 的一个对象文档模型（ODM），它允许我们以编程方式与 MongoDB 数据库进行交互，而无需使用 SQL。

开始用 Express.js 和 Mongoose 构建 RESTful API

第一步：安装依赖项

在开始构建应用程序之前，我们需要安装一些必要的软件包和库，以便我们能够建立和执行应用程序。以下是我们需要安装的软件包和库：

  • Express.js
  • Mongoose
  • body-parser
  • nodemon

使用以下命令在项目中安装它们：

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

第二步：编写基本服务器

在这一步中，我们将编写一个基本的服务器来启用我们的 RESTful API。在与此代码相关的文件中，我们将创建一个名为 server.js 的新文件。以下是我们将要编写的步骤：

  1. 导入依赖项：我们需要使用 require() 来导入我们在第一步中安装的所有软件包和库。
----- ------- - ------------------
----- ---------- - ----------------------
----- -------- - -------------------

----- --- - ---------
  1. 配置服务器：我们使用 app.use() 和 app.set() 来配置我们的服务器应在哪个端口上运行，并使我们的服务器使用 body-parser 中间件来解析请求体。
--------------------------
--------------- ---------------- -- -----
  1. 启用服务器：我们使用 app.listen() 来启动我们的服务器。下面是完整的 server.js 代码：
----- ------- - ------------------
----- ---------- - ----------------------
----- -------- - -------------------

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

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

--------------------------- -- -- -
  -------------------- ------ -- --------- -- ---- --------------------
--
  1. 启动服务器：运行以下命令以启动服务器：
---- ---------

第三步：连接数据库

在本步骤中，我们将使用 Mongoose 来连接 MongoDB 数据库。我们将在 server.js 文件中重新打开连接。下面是代码：

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

你需要将 mongodb://localhost/RESTful_API 替换为你的 MongoDB 数据库 URL。

第四步：创建数据库模型

在本步骤中，我们将使用 Mongoose 来创建 User 数据库模型。每个 Mongoose 数据库模型对应于我们在 MongoDB 中的集合。我们将使用 Mongoose 的 Schema 和 model() 方法来创建 User 数据库模型。以下是代码：

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

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

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

在上述代码中，我们首先创建一个 userSchema，其中包含 firstName、lastName、email 和 password 字段。然后，我们将 userSchema 传递给 mongoose.model() 方法，并将其命名为 User。

第五步：编写控制器和路由

在本步骤中，我们将创建控制器和路由，用于处理我们的 HTTP 请求。在至少一个 API 端点中，将使用控制器和路由。对于这种情况，我们将使用用户端点。创建新文件 userController.js 和 userRoute.js 并添加以下内容：

userController.js：

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

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

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

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

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

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

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

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

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

在 userController.js 文件中，我们创建了 createUser()、getUsers()、updateUser() 和 deleteUser() 方法来处理与特定用户相关的所有 HTTP 请求。

userRoute.js：

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

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

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

在 userRoute.js 文件中，我们创建了四个路由的定义，用于 userController.js 中定义的四个控制器方法。

第六步：将路由添加到服务器

在完成以前几步的步骤之后，我们将 userRoute.js 中的路由添加到我们在 server.js 文件中实例化的 express 实例中。其中一个方法是使用 app.use()，就像我们在配置服务器时所做的那样。在这里，我们将使用 /api 这个URL前缀来添加我们的路由。

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

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

第七步：启动应用程序和测试 RESTful API

在完成以上所有步骤后，我们将启动我们的服务器并使用 Postman 软件测试我们刚刚创建的 RESTful API。首先运行 nodemon server.js。连接到服务器后，您可以使用 Postman 应用程序进行测试，例如：

  1. 创建用户

URL：POST /api/users

请求体：

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

响应：

-
    ------ ---------------------------
    ------------ -------
    ----------- ------
    -------- -------------------
    ----------- ---------
    ------ -
-
  1. 获取所有用户

URL：GET /api/users

响应：

-
    -
        ------ ---------------------------
        ------------ -------
        ----------- ------
        -------- -------------------
        ----------- ---------
        ------ -
    -
-
  1. 更新用户

URL：PATCH /api/users/5e9f9a4c4be85707cf39614c

请求体：

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

响应：

-
    ------ ---------------------------
    ------------ ----- -----
    ----------- ---- -----
    -------- -------------------
    ----------- --------
    ------ -
-
  1. 删除用户

URL：DELETE /api/users/5e9f9a4c4be85707cf39614c

响应：

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

附加的最佳实践

以下是一些有关构建 RESTful API 的最佳实践：

  1. 使用 HTTP 动词：使用明确的 HTTP 动词来定义操作，例如 POST、GET、PUT 和 DELETE。
  2. 使用正确的状态码：为每个 HTTP 请求使用适当的状态码，例如 200 OK、201 Created、204 No Content、400 Bad Request、401 Unauthorized、403 Forbidden 和 404 Not Found。
  3. 签名请求：使用数字签名、Access Key 和 Secret Key 等术语来保护资源的安全性，并防止 CSRF 攻击。
  4. 发送适当的错误信息：包括清晰、准确和详细的错误信息使错误易于调试，并帮助更快地解决问题。
  5. 使用版本控制：使用版本控制策略，使您的 API 表示从哪个版本开始，并增加新特性时保持向后兼容性和 API 兼容性。
  6. 缓存数据：使用适当的缓存策略来减少网络往返并提高响应时间，例如浏览器缓存和服务器端缓存。
  7. 捕获错误：为了防止发生故障，使用 try / catch 块来捕获和记录任何错误，并正确处理异常。

结论

通过使用 Express.js 和 Mongoose 我们已经建立了一个完全符合 RESTful API 的 Web 应用程序。RESTful API 为开发人员提供了一种易于开发、易于使用和具有强大可扩展性的方法，可在 Web 应用程序中广泛使用。本文提供了一些重要的技巧，并提供了概述，使您可以成功构建 RESTful API。

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

阅读全文

猜你喜欢

  • 如何在 Express.js 中使用 JWT 进行身份验证？

    随着互联网及移动互联网的快速发展，越来越多的应用程序需要进行用户身份验证及管理。为了满足这些需求，使用 JSON Web Token（JWT）进行用户身份验证已经成为技术领域的常见做法。

    42 分钟前
  • 在 GraphQL 中处理复杂的对象关系

    在现代的 web 应用中，对象之间的关系变得越来越复杂。例如，一个出售商品的商店可能会有许多不同的商品，其中每个商品可能会有多个大小、颜色、类型等变体。在以前，为了处理这种情况，我们需要在后端编写各种...

    43 分钟前
  • 如何使用 Jest 测试 Node.js 应用？

    Jest 是一款由 Facebook 开发的开源 JavaScript 测试框架。它被广泛用于前端和 Node.js 应用程序的单元测试、集成测试和端到端测试。在本篇文章中，我们将学习如何使用 Jes...

    1 小时前
  • Android 开发中 Material Design 中 TabLayout 的使用技巧

    前言 随着移动互联网的快速发展，在 Android 开发中，Material Design 成为了最流行的设计指南之一。TabLayout 是 Material Design 中一个重要的组件，具有良...

    1 小时前
  • PM2 与 NGINX：构建高性能的 Node.js 应用程序

    Node.js 是一个快速而又高效的 JavaScript 运行环境，正因为如此，它已经成为了构建 Web 应用、REST API 和实时应用的理想选择。但随着 Node.js 应用程序的愈加复杂，它...

    1 小时前
  • Headless CMS 中使用 Webhooks 实现自动构建

    随着静态网页生成器的流行，Headless CMS 越来越受到开发者们的重视。Headless CMS 不仅提供了现代化的管理界面，还允许开发者通过 API 或 Webhooks 来获取内容。

    1 小时前
  • ES10 实战教程

    前言 ES10，也就是 ECMAScript 2019，是 JavaScript 的最新版本。自 2015 年发布了 ES6 以来，JavaScript 变得越来越流行，并且在近几年里，前端技术发展迅...

    1 小时前
  • Serverless 如何实现自动备份？

    在 Serverless 架构中，由于无需维护服务器，开发者可以更专注于实现业务逻辑。但是，我们还是需要解决一些重要问题，如数据备份、数据恢复和灾难恢复等。在本文中，我们将探讨如何使用 Serverl...

    1 小时前
  • Jest 测试 React 组件中使用 context 的方法探究

    在 React 应用中，我们可能需要在组件间共享一些数据或者函数，这时可以通过 Context 来实现。但是在测试使用 Context 的组件时，我们可能会遇到一些问题。

    1 小时前
  • SSE 如何设置头信息？

    简介 SSE（Server-Sent Events）是一种轻量级的实时推送技术，在前端开发中经常用于推送服务器实时消息，比如聊天、订阅等。SSE 可以通过 HTTP 协议进行传输，因此需要设置合适的头...

    1 小时前
  • 在 Docker 容器中使用 SSH

    随着前端应用程序的复杂性增加，开发环境的设置变得越来越麻烦。 Docker 是一个流行的容器化解决方案，它可以帮助我们在标准化的环境中进行开发。在这篇文章中，我们将学习如何在 Docker 容器中使用...

    1 小时前
  • CSS Grid 游戏（Grid Garden）学习笔记

    CSS Grid 游戏（Grid Garden）学习笔记 CSS Grid 是一个强大的布局工具，它可以让我们轻松地实现复杂的网页布局。但是，学习 CSS Grid 的过程可能会有些枯燥。

    1 小时前
  • React 中使用 setInterval 时的注意事项

    引言 在 React 中，我们很常见地使用 setInterval 来创建周期性的任务。在实际开发中，我们需要注意一些细节和陷阱，以确保周期性任务能够正确地运行。本文将会介绍 React 中使用 se...

    1 小时前
  • 如何在使用 CSS Reset 的情况下保持 flexbox 布局？

    什么是 CSS Reset？ 在我们开始探讨在使用 CSS Reset 的情况下保持 flexbox 布局之前，我们需要先了解什么是 CSS Reset。CSS Reset 是一种用于归零不同浏览器之...

    1 小时前
  • 使用 Web Components 构建可重用的模态框组件

    Web Components 是 Web 技术的一种新型组成部分，可以让开发者创建封装的自定义元素。通过 Web Components，开发者可以更加轻松地构建可重用的 UI 组件。

    1 小时前
  • 如何优化 iOS 应用程序的性能

    作为一名前端开发人员，我们常常需要优化我们的应用程序的性能，以提供更好的用户体验。在 iOS 平台上，优化应用程序的性能尤为重要。本文将介绍一些优化 iOS 应用程序性能的技巧和策略，帮助开发人员提高...

    1 小时前
  • 响应式设计中的样式调整

    随着移动设备的普及，人们越来越多地使用手机和平板电脑浏览网站。因此，响应式设计已成为现代 Web 设计的必要趋势。在响应式设计中，我们需要针对不同的设备大小和屏幕分辨率，调整样式和布局以确保网站能够良...

    1 小时前
  • 在 Fastify 中处理文件上传

    Fastify 是一个快速、低开销和易于学习的 Web 框架，其性能排名领先。在开发过程中，我们经常需要处理文件上传。本文将介绍如何在 Fastify 中处理文件上传。

    1 小时前
  • ES11 中的 Object.fromEntries() - 一个实用工具

    ES11 中的 Object.fromEntries() - 一个实用工具 在 ES2019 中，一个新的 Object 静态方法 fromEntries() 加入了 JavaScript。

    1 小时前
  • 如何用良好的界面设计提升 App 无障碍性？

    随着技术的不断进步和社会的不断发展，越来越多的人开始重视无障碍性设计，这样有助于让更多的人都能够顺利、愉快地使用各种应用程序。尤其是在移动应用程序中，良好的界面设计不仅可以提高用户的使用体验，还可以提...

    1 小时前

相关推荐