使用 Express.js 构建 RESTful API 的详细教程

阅读时长 7 分钟读完

在前端开发中,构建 RESTful API 是非常重要的一项技能。通过 RESTful API,我们可以使前端与后端之间的数据交互更加简单、高效和安全。Express.js 是一种非常流行的 Node.js 框架,可以帮助我们构建 RESTful API。本文将介绍如何使用 Express.js 构建 RESTful API 的详细教程,旨在提供深度学习和指导意义。

环境配置

在开始学习构建 RESTful API 前,需要确保已经安装了 Node.js 和 Express.js。可以通过以下命令确认是否已经安装:

如果未安装,请根据自己的操作系统前往官网下载安装。安装完成后,可以新建一个文件夹并通过以下命令初始化一个新的 Node.js 项目:

创建 Express.js 应用程序

在项目中安装 Express.js 后,需要创建 Express.js 应用程序并将其连接到服务器。可以通过以下命令实现:

然后,在项目的根文件夹下创建一个 server.js 文件,并在其中编写以下代码:

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

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

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

上述代码创建了一个 Express.js 应用程序,并将其连接到 localhost:3000 服务器。当用户访问该服务器时,将会收到 "Hello World!" 信息。

RESTful API 设计

RESTful API 请求是有一定规则的,根据不同的 HTTP 方法需要进行不同的处理。下面介绍常用的 RESTful API 请求规则。

  • GET:获取某个资源的信息。
  • POST:新建资源(也可以用于更新资源)。
  • PUT:更新资源。
  • DELETE:删除某个资源。

使用上述 HTTP 方法后,需要定义资源请求的路径和请求的相关参数,并且返回对应的资源数据,这些内容在使用 Express.js 构建 RESTful API 时都需要非常注意。

创建 RESTful API 路由

在 Express.js 中,可以使用 Router 对象来创建 RESTful API 路由,从而更好地管理和组织代码。接下来,我们将使用 Router 对象来创建 RESTful API 路由。

为了进行示范,我们将创建一个简单的 RESTful API,用于管理用户。在 server.js 文件中添加如下代码:

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

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

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

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

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

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

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

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

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

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

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

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

上述代码中,我们使用 express.Router() 创建了一个名为 userRouter 的路由器,并为其定义了 GET、POST、PUT 和 DELETE 方法的路由。其中, GET /api/users 将返回用户列表, GET /api/users/:id 根据用户 ID 返回单个用户信息, POST /api/users 将创建一个新的用户, PUT /api/users/:id 将更新指定用户信息, DELETE /api/users/:id 将删除指定用户。此外,该示例中还使用 express.json() 中间件向服务器传递 JSON 格式数据。

案例应用

现在,我们已经创建了一个简单的 RESTful API,可以使用 Postman 或其他 API 测试工具进行测试。

下面展示如何使用 Axios 库在前端发送请求并获取 RESTful API 中的数据。

在前端项目中安装 Axios:

然后在前端代码中添加如下代码:

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

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

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

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

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

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

上述代码中,使用 axios 库向 RESTful API 发送 GET、POST、PUT 和 DELETE 请求,从而实现了前端与后端之间的数据传递,实现了前后端的连接。

总结

本文介绍了如何使用 Express.js 构建 RESTful API 的详细教程。通过本文的学习,您应该已经掌握了使用 Express.js 创建 RESTful API 的基本方法。希望通过本文的学习,您可以更好地掌握前端开发中重要的一项技能,并在日后的开发中能够更加高效地管理和组织代码,实现更加优异的代码效果。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/645f6b2a968c7c53b01711b0

纠错
反馈