简介
在现代 Web 应用程序中，RESTful API 是构建应用程序的重要组成部分。通过 RESTful API，应用程序可以轻松地与客户端进行通信，使得客户端可以发送和接收数据。
Express.js 是一个流行的 Node.js 框架，具有轻量级、灵活和易于使用的优点。通过使用 Express.js，我们可以很容易地编写基本的 REST API。
在本文中，我们将介绍如何使用 Express.js 编写基本的 REST API。我们将会讨论一些关键概念，并提供具体的代码示例，以帮助开发人员更好地理解和实现 RESTful API。
前提条件
在本文中，我们将使用 Node.js 和 Express.js。因此，在开始本文之前，请确保您已经在您的计算机上安装了 Node.js 和 Express.js。如果您还没有安装 Node.js，请访问 nodejs.org 下载最新版本。
RESTful API 的基本原则
RESTful API 基于一些基本原则。以下是这些原则的简要概述：
- 使用 HTTP 动词来指定操作类型 (例如 GET、POST、PUT、DELETE 等)。
- 使用资源路径来唯一标识每个资源。
- 使用请求荷载来包含必要的数据。
- 使用 HTTP 状态码来表示请求的成功或失败。
在接下来的代码示例中，我们将解释如何使用这些原则来启用基本的 RESTful API。
示例代码
以下是使用 Express.js 编写基本 RESTful API 的示例代码：
-- -------------------- ---- -------
----- ------- - -------------------
----- ---------- - -----------------------
----- --- - ----------
------------------------------- --------- ----- ----
---------------------------
----- ----- - -
- --- -- ------ ---- ----- -------- ------- --- ----- ----------- --
- --- -- ------ --- ---- - ------------- ------- ------- ---- --
- --- -- ------ ------- ------- ------- ------- --
--
----------------- ----- ---- -- -
----------------
---
--------------------- ----- ---- -- -
----- ---- - -------------- -- ---- --- -------------------------
-- ------- ------ -------------------------- --- --------
---------------
---
------------------ ----- ---- -- -
----- ---- - -
--- ------------ - --
------ ---------------
------- ----------------
--
-----------------
-------------- ------- ---------------
---
--------------------- ----- ---- -- -
----- ---- - -------------- -- ---- --- -------------------------
-- ------- ------ -------------------------- --- --------
---------- - ---------------
----------- - ----------------
-------------- ------- ---------------
---
------------------------ ----- ---- -- -
----- ---- - -------------- -- ---- --- -------------------------
-- ------- ------ -------------------------- --- --------
----- ----- - --------------------
------------------- ---
-------------- ------- ---------------
---
---------------- -- -- ------------------- ------- -- ---- --------解释
让我们逐步解释每个代码块的作用：
const express = require('express');
const bodyParser = require('body-parser');
const app = express();
app.use(bodyParser.urlencoded({ extended: false }));
app.use(bodyParser.json());在这些行中，我们导入了必要的模块并初始化了 Express 应用程序。我们还使用 body-parser 中间件来解析 HTTP 请求正文中的数据。此外，我们还指定了两种解析数据的方法：extended 和 json。
const books = [
{ id: 1, title: 'The Great Gatsby', author: 'F. Scott Fitzgerald' },
{ id: 2, title: 'To Kill a Mockingbird', author: 'Harper Lee' },
{ id: 3, title: '1984', author: 'George Orwell' },
];在这些行中，我们定义了一个初始数组：books。这是我们将在我们的 API 中使用的数据。
-- -------------------- ---- -------
----------------- ----- ---- -- -
----------------
---
--------------------- ----- ---- -- -
----- ---- - -------------- -- ---- --- -------------------------
-- ------- ------ -------------------------- --- --------
---------------
---
------------------ ----- ---- -- -
----- ---- - -
--- ------------ - --
------ ---------------
------- ----------------
--
-----------------
-------------- ------- ---------------
---
--------------------- ----- ---- -- -
----- ---- - -------------- -- ---- --- -------------------------
-- ------- ------ -------------------------- --- --------
---------- - ---------------
----------- - ----------------
-------------- ------- ---------------
---
------------------------ ----- ---- -- -
----- ---- - -------------- -- ---- --- -------------------------
-- ------- ------ -------------------------- --- --------
----- ----- - --------------------
------------------- ---
-------------- ------- ---------------
---这些行实现了 RESTful API 的具体功能。我们使用在路由路径中定义的 HTTP 动词来指定每个操作的类型。我们使用一个数组 books 来存储我们的数据。
在 GET /books 路由中，我们简单地发送整个 books 数组。在 GET /books/:id 路由中，我们通过 id 参数找到与请求中所提供的 id 匹配的单个图书。POST /books 路由允许创建新的书籍。PUT /books/:id 路由允许更新具有指定 id 的书籍。最后，DELETE /books/:id 路由允许删除具有指定 id 的书籍。
app.listen(3000, () => console.log('Server started on port 3000'));最后，我们告诉服务器在端口 3000 上运行并开始监听请求。
结论
在本文中，我们介绍了如何使用 Express.js 编写基本的 RESTful API。我们讨论了 RESTful API 的基本原则，并提供了具体的代码示例来演示这些原则。我们希望这篇文章可以帮助您更好地理解 RESTful API，并帮助您在 Express.js 中构建您自己的 API。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6705f094d91dce0dc855fa95