RESTful API 是一种 Web API 设计风格，它是一种轻量级、可扩展且易于理解的架构风格。它是基于 HTTP 协议，通过对资源的表现层状态转移进行操作，实现客户端和服务器之间的数据交互。
在 Node.js 中，我们可以使用 Express 框架来快速搭建 RESTful API。本文将详细介绍如何使用 Express 搭建 RESTful API，并提供示例代码以供参考。
安装 Express
在开始之前，我们需要先安装 Express。可以使用 npm 命令进行安装：
npm install express
创建项目
在安装 Express 后，我们可以开始创建项目。首先，创建一个新的目录，并在其中创建一个名为 index.js 的文件。在 index.js 文件中，我们将编写我们的 Express 应用程序。
mkdir myapp cd myapp touch index.js
编写代码
在 index.js 文件中，我们需要先引入 Express 模块，并创建一个 Express 应用程序实例。然后，我们可以使用 Express 的路由功能来定义 API 的端点。
以下是一个简单的示例代码，它定义了一个 GET 请求处理程序，并返回一个 JSON 响应。
-- -------------------- ---- ------- ----- ------- - ------------------- ----- --- - ---------- ------------ ----- ---- -- - ---------- -------- ------ ------- --- --- ---------------- -- -- - ------------------- -- --------- -- ---- ------- ---
在这个示例中，我们定义了一个名为 app 的 Express 应用程序实例。我们使用 app.get() 方法来定义一个 GET 请求处理程序，它监听根路径 / 的请求。当请求到达时，它将返回一个 JSON 响应，包含一个名为 message 的属性和一个值为 Hello World! 的字符串。
最后，我们使用 app.listen() 方法来启动服务器，并将其绑定到端口 3000。当服务器启动时，它将在控制台中打印一条消息。
使用路由参数
在上面的示例中，我们定义了一个根路径的 GET 请求处理程序。但是，RESTful API 中的路由通常包含参数，例如 /users/:id。在 Express 中，我们可以使用路由参数来处理这些请求。
以下是一个示例代码，它定义了一个 GET 请求处理程序，使用路由参数来获取用户 ID 并返回一个 JSON 响应。
app.get('/users/:id', (req, res) => {
const userId = req.params.id;
res.json({ message: `User ${userId} requested` });
});在这个示例中，我们使用 /users/:id 来定义路由。当请求到达时，Express 会将路由参数 id 存储在 req.params 对象中。我们可以使用 req.params.id 来获取用户 ID，并将其包含在响应中。
使用中间件
Express 的中间件是一种函数，它可以在请求和响应之间执行某些操作。例如，我们可以使用中间件来记录请求日志、验证用户身份等。
以下是一个示例代码，它使用 morgan 中间件来记录请求日志。
const morgan = require('morgan');
app.use(morgan('tiny'));
app.get('/', (req, res) => {
res.json({ message: 'Hello World!' });
});在这个示例中，我们使用 app.use() 方法来注册 morgan 中间件。morgan 中间件将记录每个请求的日志，并将其输出到控制台。然后，我们定义了一个根路径的 GET 请求处理程序，它返回一个 JSON 响应。
使用数据库
在实际应用中，我们通常需要使用数据库来存储和检索数据。在 Node.js 中，我们可以使用多种数据库，例如 MongoDB、MySQL 等。
以下是一个示例代码，它使用 mongoose 模块来连接 MongoDB 数据库，并定义了一个模型来表示用户。
-- -------------------- ---- ------- ----- -------- - -------------------- ----- ------ - ---------------- --------------------------------------------- - ---------------- ----- ------------------- ---- --- ----- ---------- - --- -------- ----- ------- ------ ------ --- ----- ---- - ---------------------- ------------ ----------------- ----- ----- ---- -- - ----- ----- - ----- ------------ ---------------- ---
在这个示例中，我们使用 mongoose.connect() 方法来连接 MongoDB 数据库。然后，我们定义了一个名为 User 的模型，它表示数据库中的用户。最后，我们定义了一个 /users 路径的 GET 请求处理程序，它使用 User.find() 方法来检索所有用户，并将它们包含在 JSON 响应中。
结论
在本文中，我们介绍了如何使用 Express 搭建 RESTful API，并提供了示例代码以供参考。通过使用 Express，我们可以快速构建高效、可扩展和易于维护的 API。希望这篇文章能够帮助你更好地理解 RESTful API 和 Express 框架。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/672634392e7021665e19be8b