如何使用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中文網其他相關文章！