技术教程：使用 Node.js 构建 RESTful API

AI 编程助手，豆包旗下的编程助手，提供智能补全、智能预测、智能问答等能力，节省开发时间，释放脑海中的创造力，支持 VSCode，点击体验 AI

在现代 Web 应用程序开发中，RESTful API 已成为前端开发者的必备技能之一。Node.js 作为一个高效的 JavaScript 运行时环境，已被广泛应用于构建 RESTful API。在本篇技术教程中，我们将学习如何使用 Node.js 构建一个简单的 RESTful API，并说明其工作原理。

什么是 RESTful API？

RESTful API 是一种使用 HTTP 协议进行通信的 Web API，其设计风格标准化、灵活、可扩展、易于使用和维护。REST 是 Representational State Transfer（表现层状态转移）的缩写。

在 RESTful API 设计中，每个资源都通过一个 URI（统一资源标识符）来标识，可以通过 HTTP 方法（如 GET、POST、PUT、DELETE 等）对这些资源进行 CRUD（增删改查）操作。

Node.js 与 Express

Node.js 是一个基于 Chrome V8 引擎的 JavaScript 运行时环境，可以在服务器端运行 JavaScript。Express 是 Node.js 的一个开源 Web 应用程序框架，为开发 RESTful API 提供了强大的支持。

使用 Node.js 和 Express 可以快速创建和部署 Web 应用程序，支持各种 HTTP 方法和路由功能，并且可以与各种数据库系统集成。

API 设计和实现

在这里我们将用 Express 框架实现一个简单的 RESTful API。假设我们要创建一个文章发布平台，其中包含文章、评论和用户对象。

首先在终端中输入以下代码：

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

这将创建一个项目目录，并通过 npm 安装 Express、body-parser、cors、mongoose 和 nodemon。

接下来创建一个 index.js 文件，并添加以下代码：

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

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

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

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

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

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

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

在这里，我们引入了 Express、body-parser、cors 和 mongoose，然后创建并初始化了一个 Express 实例。接下来，我们使用 app.use 中间件安装了 cors 和 body-parser。

然后我们连接了一个本地 MongoDB 数据库。在这里，我们使用了一个名为 my-api 的数据库。

最后，我们定义了一个监听在 Port 4000 上的 Express 服务器，并将路由应用于该服务器实例。在这里，我们定义了三种不同类型的路由，即文章、评论和用户。我们需要在项目的根目录中为每种路由添加一个名为 routes 的新目录，并在其中创建名为 articles.js、comments.js 和 users.js 的文件。在这些文件中，我们将定义相关路由和 API 端点。

文章路由

在 routes/articles.js 文件中，我们可以添加以下代码：

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

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

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

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

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

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

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

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

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

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

在这里，我们定义了一个包含 GET、POST、PUT 和 DELETE 方法的文章路由。我们定义了以下路由端点：获取所有文章、添加一篇新文章、通过 ID 查找文章、通过 ID 更新文章和通过 ID 删除文章。

这里，我们使用文章模型，它使用 Mongoose 模式来定义文章对象的属性。在这个例子中，我们将文章的属性定义为标题、作者和内容。

评论路由

在 routes/comments.js 文件中，我们可以添加以下代码：

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

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

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

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

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

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

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

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

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

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

在这里，我们定义了一个包含 GET、POST、PUT 和 DELETE 方法的评论路由。我们定义了以下路由端点：获取所有评论、添加一条新评论、通过 ID 查找评论、通过 ID 更新评论和通过 ID 删除评论。

这里，我们使用评论模型，它使用 Mongoose 模式来定义评论对象的属性。在这个例子中，我们将评论的属性定义为文章 ID、作者和内容。

用户路由

在 routes/users.js 文件中，我们可以添加以下代码：

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

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

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

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

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

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

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

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

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

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

在这里，我们定义了一个包含 GET、POST、PUT 和 DELETE 方法的用户路由。我们定义了以下路由端点：获取所有用户、添加一个新用户、通过 ID 查找用户、通过 ID 更新用户和通过 ID 删除用户。

这里，我们使用用户模型，它使用 Mongoose 模式来定义用户对象的属性。在这个例子中，我们将用户的属性定义为用户名。

模型

在这里，我们使用 Mongoose 模式来定义我们的文章、评论和用户模型。在 models/article.model.js 文件中，我们可以添加以下代码：

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

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

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

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

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

在这里，我们定义了一个名为 Article 的模型，它具有标题、作者和内容属性。此外，我们将使用 timestamps 选项为每个文章自动加入创建时间和更新时间属性。

在 models/comment.model.js 文件中，我们可以添加以下代码：

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

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

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

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

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

在这里，我们定义了一个名为 Comment 的模型，它具有文章 ID、作者和内容属性。此外，我们将使用 timestamps 选项为每条评论自动加入创建时间和更新时间属性。

在 models/user.model.js 文件中，我们可以添加以下代码：

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

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

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

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

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

在这里，我们定义了一个名为 User 的模型，它有用户名、年龄和电子邮件属性。此外，我们将使用 timestamps 选项为每个用户自动加入创建时间和更新时间属性。

结论

在这篇技术教程中，我们讲解了如何使用 Node.js 和 Express 构建 RESTful API。我们介绍了 RESTful API 设计的设计思想，然后使用 Mongoose 模式定义了三种类型的路由和数据模型。此外，我们还指出了在 API 开发过程中如遇到问题，可以使用代码调试技术来查找错误并进行修正。

通过学习本篇技术教程，您将了解如何使用 Express 框架、Mongoose 模式和 Node.js 进行 API 开发。通过创建一个简单的 RESTful API，您将掌握与客户端交互和数据库集成的基本方法，从而为未来更复杂的项目打下基础。

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

阅读全文

猜你喜欢

  • 如何优化大型 LESS 文件的编译速度

    在前端开发中，LESS 是一种非常流行的 CSS 预处理器。它可以大大提高 CSS 的可维护性和可扩展性。但是，在处理大型 LESS 文件时，编译速度可能会变得非常缓慢。

    5 天前
  • Web Components 升级 v1.0：了解下

    Web Components 是一种用于构建可重用 Web 应用组件的标准。自从其首次发布以来，Web Components 已经成为了前端开发中的一个重要话题。最近，Web Components 升...

    5 天前
  • 如何使用 Enzyme 和 Jest 进行 React-Router 组件测试

    React-Router 是一个常用的前端路由库，它可以方便地管理应用程序的路由，让我们可以在不刷新页面的情况下切换不同的页面。然而，测试 React-Router 组件的过程并不容易，因为路由的状态...

    5 天前
  • Vue.js 网站设计优化，实现无障碍性体验！

    在现代网站设计中，无障碍性已经成为一个越来越重要的主题。无障碍性是指让所有人都能方便地访问和使用网站，包括身体上、感知上和认知上有障碍的人。这些人包括盲人、失明人、聋人、色盲人、智力障碍者等等。

    5 天前
  • MongoDB 3.4 新功能解读与应用

    简介 MongoDB 是一个广泛使用的 NoSQL 数据库，它使用文档存储数据，而不是传统的关系型数据库中的行和列。MongoDB 3.4 是 MongoDB 的一个重要版本，它带来了很多新的功能和改...

    5 天前
  • ECMAScript 2019 (ES10) 中的模板字面量：新特性和使用技巧

    在 ECMAScript 2019 (ES10) 中，模板字面量是一个重要的新特性。模板字面量是一种用于创建字符串的语法糖，使得字符串的拼接和格式化变得更加简单和直观。

    5 天前
  • 如何解决 Vue.js 单页应用刷新页面后空白的问题

    在使用 Vue.js 开发单页应用时，我们经常会遇到一个问题：当用户手动刷新页面时，页面会变成空白，无法正常显示应用内容。这是因为单页应用的所有路由都是由前端路由控制的，而刷新页面会向服务器发送请求，...

    5 天前
  • Kubernetes 集群中如何进行备份和恢复

    前言 Kubernetes 是一种流行的容器编排系统，它可以帮助开发者管理容器化应用程序的部署、扩展和管理。然而，当你在使用 Kubernetes 时，你需要考虑如何备份和恢复你的应用程序和数据。

    5 天前
  • 如何设计适配不同屏幕的响应式表单

    在现代 Web 开发中，响应式设计已经成为了一个必要的技能。随着越来越多的人使用移动设备浏览网站，我们需要确保我们的表单可以适应不同屏幕尺寸和设备类型。在本文中，我们将介绍如何设计适配不同屏幕的响应式...

    5 天前
  • LESS 中的 mixin 函数与函数式编程风格

    LESS 是一种 CSS 预处理器，它提供了许多方便的功能来简化 CSS 的编写。其中之一就是 mixin 函数，它可以让我们定义一些可重用的 CSS 样式块，以便在不同的地方重复使用。

    5 天前
  • 详解SASS中的 @mixin 指令

    SASS 是一种 CSS 预处理器，它扩展了 CSS 向后兼容和提供了许多方便的功能。其中一个重要的功能就是 @mixin 指令。该指令允许前端开发者将重复的代码封装成可重用的块，并使用参数定制每个块...

    5 天前
  • Web Components 开发的权威指南

    Web Components 是一种用于构建可重用 UI 组件的技术，它可以帮助开发者创建可复用、可维护、可测试和跨平台的组件。在本文中，我们将深入探讨 Web Components 的开发和使用，帮...

    5 天前
  • Angular 单页面应用的集成与部署

    Angular 是一款流行的前端框架，它可以帮助我们构建单页面应用（Single Page Application，SPA）。在构建 SPA 的过程中，我们需要考虑如何将 Angular 应用集成到我...

    5 天前
  • 解决 Next.js 首页加载速度慢的问题

    Next.js 是一个流行的 React 框架，可以帮助开发者快速构建 SSR 应用程序。但是，有时候 Next.js 的首页加载速度可能会很慢，这会影响用户体验并降低 SEO 排名。

    5 天前
  • ECMAScript 2016 中的 Array.prototype.fill() 方法的使用及常见错误

    在 ECMAScript 2016 中，新增了 Array.prototype.fill() 方法，用于填充数组中的元素。该方法可以接受三个参数，分别是填充的值、起始索引和结束索引。

    5 天前
  • Redux 是如何解决 Action 管理的 Concerns

    在前端开发中，管理应用程序的状态是一个重要的问题。Redux 是一个流行的状态管理库，它提供了一种可预测的管理状态的方式，使得状态的变化和应用程序的行为变得更加清晰和可控。

    5 天前
  • 如何构建 Angular 应用的生产版本

    Angular 是一个流行的前端开发框架，它提供了丰富的功能和灵活的架构，使得开发者可以更加高效地开发现代化的 Web 应用程序。在开发过程中，我们需要构建 Angular 应用的生产版本，以便能够更...

    5 天前
  • 如何使用 Tailwind CSS 实现响应式倒计时效果

    Tailwind CSS 是一种快速、高效的 CSS 框架，它提供了大量的 CSS 类，可以帮助开发者快速构建漂亮的界面。在本文中，我们将介绍如何使用 Tailwind CSS 实现响应式倒计时效果。

    5 天前
  • 如何配置 ESLint 进行代码检查？

    ESLint 是一个非常流行的 JavaScript 代码检查工具，它可以帮助开发者在开发过程中发现代码中的潜在问题，从而提高代码质量和可维护性。本文将介绍如何配置 ESLint 进行代码检查，并提供...

    5 天前
  • 如何使用 Enzyme 和 Redux-Thunk 测试 Redux-React 组件的异步 API 请求

    在前端开发中，测试是非常重要的一环。特别是在涉及到异步请求的情况下，测试变得更加复杂。在这篇文章中，我们将介绍如何使用 Enzyme 和 Redux-Thunk 测试 Redux-React 组件的异...

    5 天前

相关推荐

    暂无文章