如何使用node.js和express.js创建REST API（用于初学者）

构建 REST API 是后端开发的一项基本技能。本文将指导您如何使用 Node.js 和 Express.js 创建一个简单的 REST API。本指南将提供一个清晰的、循序渐进的过程来构建您的第一个 API。

注意：本教程不集成任何数据库，而是使用内存数组。

---

什么是 REST API？

REST API（具象状态传输应用程序编程接口）是一套用于构建和交互式 Web 服务的规则和约定。它使用 HTTP 方法（如 GET、POST、PUT 和 DELETE）对资源执行操作，通常以 JSON 格式返回数据。

---

先决条件

在开始之前，请确保您已安装以下内容：

1. Node.js: 从 nodejs.org 下载并安装它。
2. 代码编辑器: 使用您喜欢的任何编辑器，例如 Visual Studio Code、Sublime Text 或 Atom。
3. Postman（可选）：用于测试您的 API 端点的工具。从 postman.com 下载它。

---

步骤 1：设置您的项目

1. 创建项目目录

打开您的终端并为您的项目创建一个新目录：

<code>mkdir my-rest-api
cd my-rest-api</code>

2. 初始化 Node.js 项目

运行以下命令以创建 package.json 文件：

<code>npm init -y</code>

-y 标志会自动为您的项目填写默认值。

---

步骤 2：安装所需的包

1. 安装 Express.js

Express.js 是 Node.js 的一个轻量级 Web 框架。使用以下命令安装它：

<code>npm install express</code>

2. 安装 Nodemon（可选）

每当您更改代码时，Nodemon 都会自动重启您的服务器。将其安装为开发依赖项：

<code>npm install --save-dev nodemon</code>

---

步骤 3：创建基本服务器

1. 创建 index.js 文件

在您的项目目录中，创建一个名为 index.js 的文件：

<code>touch index.js</code>

2. 设置服务器

打开 index.js 并添加以下代码：

<code class="language-javascript">// 导入 express 模块
const express = require('express');

// 创建 express 实例
const app = express();

// 定义端口号
const PORT = 3000;

// 解析 JSON 主体的中间件
app.use(express.json());

// 定义一个简单的路由
app.get('/', (req, res) => {
    res.send('Hello, World!');
});

// 启动服务器并在指定的端口上监听
app.listen(PORT, () => {
    console.log(`服务器正在运行在 http://localhost:${PORT}`);
});</code>

3. 运行服务器

使用以下命令启动服务器：

<code>node index.js</code>

如果您安装了 Nodemon，请使用：

<code>npx nodemon index.js</code>

在浏览器中访问 https://www.php.cn/link/8cad09283d1d6c5fb08daec8a576a72d, World!”。

---

步骤 4：添加 CRUD 操作

让我们创建一个简单的 REST API 来管理项目列表。我们将使用内存数组来存储数据。

1. 创建内存数组

在 app.use(express.json()); 后添加此行：

<code>mkdir my-rest-api
cd my-rest-api</code>

2. 定义 CRUD 路由

GET /items: 获取所有项目

<code>npm init -y</code>

GET /items/:id: 通过 ID 获取单个项目

<code>npm install express</code>

POST /items: 创建一个新项目

<code>npm install --save-dev nodemon</code>

PUT /items/:id: 通过 ID 更新项目

<code>touch index.js</code>

DELETE /items/:id: 通过 ID 删除项目

<code class="language-javascript">// 导入 express 模块
const express = require('express');

// 创建 express 实例
const app = express();

// 定义端口号
const PORT = 3000;

// 解析 JSON 主体的中间件
app.use(express.json());

// 定义一个简单的路由
app.get('/', (req, res) => {
    res.send('Hello, World!');
});

// 启动服务器并在指定的端口上监听
app.listen(PORT, () => {
    console.log(`服务器正在运行在 http://localhost:${PORT}`);
});</code>

---

步骤 5：测试您的 API

使用 Postman 或 cURL 测试您的 API 端点：

1. GET https://www.php.cn/link/8a701b176cc140888936dad15c5d046a – 检索所有项目。
2. POST https://www.php.cn/link/8a701b176cc140888936dad15c5d046a – 创建一个新项目。发送一个类似于 {"name": "项目 1"} 的 JSON 主体。
3. GET https://www.php.cn/link/8a701b176cc140888936dad15c5d046a/1 – 通过 ID 检索单个项目。
4. PUT https://www.php.cn/link/8a701b176cc140888936dad15c5d046a/1 – 更新项目。发送一个类似于 {"name": "已更新的项目 1"} 的 JSON 主体。
5. DELETE https://www.php.cn/link/8a701b176cc140888936dad15c5d046a/1 – 通过 ID 删除项目。

---

步骤 6：添加错误处理（可选）

要全局处理错误，请在 index.js 文件的末尾添加此中间件：

<code>node index.js</code>

---

步骤 7：组织您的代码（可选）

随着项目的发展，您可以将代码组织到单独的文件和文件夹中。例如：

• routes/：定义路由。
• controllers/：处理业务逻辑。
• models/：定义数据结构。

---

最终代码

这是完整的 index.js 文件：

<code>npx nodemon index.js</code>

---

结论

恭喜！您已使用 Node.js 和 Express.js 构建了一个简单的 REST API。这仅仅是开始——您还可以做更多的事情，例如集成数据库、添加身份验证或将您的 API 部署到云端。

继续尝试，祝您编码愉快！

以上是如何使用node.js和express.js创建REST API（用于初学者）的详细内容。更多信息请关注PHP中文网其他相关文章！