在现代 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。假设我们要创建一个文章发布平台，其中包含文章、评论和用户对象。
首先在终端中输入以下代码：
mkdir my-api && cd my-api npm init -y npm install express body-parser cors mongoose nodemon --save
这将创建一个项目目录，并通过 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