在 Node.js 和 Express.js 中创建 API 端点的完整指南
API（应用程序编程接口）是现代 Web 应用程序的重要组成部分。它允许应用程序与外部系统进行通信，同时也可以供其他应用程序使用。在本文中，我们将探讨如何在 Node.js 和 Express.js 中创建 API 端点的完整指南。
- 创建一个 Express.js 应用
在开始创建 API 端点之前，我们需要创建一个 Express.js 应用。在此之前，确保已经安装 Node.js 和 NPM，并在本地计算机上设置了 Node.js 环境。打开终端并运行以下命令以安装 Express.js：
npm install express --save
接下来，请按照以下方式创建一个 Express.js 应用：
// 引入 Express.js
const express = require('express');
// 创建 Express.js 应用
const app = express();
// 监听端口号
app.listen(3000, () => console.log('Server running on port 3000'));现在，我们已经创建了一个 Express.js 应用并将其设置为在本地计算机上的端口3000上运行。我们可以在浏览器中输入“http://localhost:3000”以检查应用程序是否在运行。
- 创建 API 端点
现在，我们可以开始创建 API 端点。要创建 API 端点，请使用如下代码：
// 创建 API 端点
app.get('/api', (req, res) => {
res.send('Hello World!');
});在上面的代码中，我们使用 Express.js 的 get() 方法来创建一个名为“/api”的端点。当客户端发送 GET 请求到此端点时，将执行回调函数并返回“Hello World!”作为响应。
您也可以使用 POST、PUT、DELETE 等 HTTP 方法来创建 API 端点。例如：
-- -------------------- ---- ------- -- -- ---- --- -- ---------------- ----- ---- -- - ------------------ - ---- ---------- --- -- -- --- --- -- --------------- ----- ---- -- - ------------------ - --- ---------- --- -- -- ------ --- -- ------------------ ----- ---- -- - ------------------ - ------ ---------- ---
- 处理 API 查询参数
在我们编写的许多 API 端点中，可能需要使用查询参数进行筛选，排序，限制和分页等操作。您可以使用 Express.js 的 query 属性来访问查询参数。以下示例演示如何处理查询参数：
// 创建查询参数 API 端点
app.get('/api/query', (req, res) => {
const { page, size, sort } = req.query;
res.send(`Received a GET request with page=${page}, size=${size}， sort=${sort}`);
});在这个示例中，我们使用“/api/query”端点来处理查询参数，并将参数的值打印在响应中。查询参数通过“?”分隔符对端点进行分割，并使用“&”分隔符分隔不同的查询参数。例如：http://localhost:3000/api/query?page=1&size=10&sort=desc。
- 处理 API 请求体
除了查询参数之外，很多 API 端点还需要访问 HTTP 请求体。请求体通常包含 POST、PUT 和 DELETE 等操作中要传递的数据。在 Express.js 中，我们可以使用 req.body 访问请求体的内容。以下是一个使用 req.body 的示例：
// 创建请求体 API 端点
app.post('/api/body', (req, res) => {
const { name } = req.body;
res.send(`Received a POST request with name=${name}`);
});在上面的示例中，我们将“/api/body”端点用于处理 POST 请求，并使用 req.body 对请求体内容进行解析。
- 集成外部数据源
许多现代应用程序需要使用外部数据源来完成其运行。为了从外部数据源获取数据，我们可以使用 Axios 或其他类似的库。以下是一个示例：
npm install axios --save
-- -------------------- ---- -------
-- -- ----- -
----- ----- - -----------------
-- -- --- ------------
-------------------- ----- ----- ---- -- -
--- -
----- -------- - ----- --------------------------------------------------------
------------------------
- ----- ------- -
---------------------
-
---在上面的示例中，我们使用“/api/data”端点来调用外部数据源，并返回其响应。
- 使用数据库
为了存储和管理数据，我们可以使用数据库。在 Node.js 中，我们可以使用许多不同类型的数据库，例如 MongoDB、MySQL 和 PostgreSQL 等。以下是一个使用 MongoDB 的示例：
npm install mongoose --save
-- -------------------- ---- -------
-- -- -------- -
----- -------- - --------------------
-- --- ------- ---
--------------------------------------------------- - ---------------- ----- ------------------- ---- --
-------- -- -------------------- ------------
-------------- -- ----------------------
-- ------
----- ---------- - --- -----------------
----- -------
------ -------
---- -------
---
-- ----
----- ---- - ---------------------- ------------
-- -- --- ----------------
----------------------- ----- ----- ---- -- -
--- -
----- ----- - ----- ------------
----------------
- ----- ------- -
---------------------
-
---在上面的示例中，我们使用 Mongoose 库连接到 MongoDB，创建一个 User 模型，并使用“/api/mongodb”端点获取数据库中的所有用户。
结论
现在，您已经了解如何在 Node.js 和 Express.js 中创建 API 端点的完整指南。创建 API 端点的关键是定义端点路径，使用 HTTP 方法创建端点，同时处理查询参数和请求体。通过使用外部数据源和数据库，您可以轻松地扩展应用程序并管理其数据。希望本文能为使用 Node.js 和 Express.js 的前端开发者提供足够的指导意义和学习价值。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/670cdb195f551281025bdcc0