使用 Express.js 建立 API 的初學者指南

API（應用程式介面）是現代 Web 應用程式的支柱，支援前端和後端之間的通訊。 Express.js 是用 JavaScript 建立 API 的最受歡迎的工具之一，它是一個極簡且靈活的 Node.js 框架。本指南將引導您了解使用 Express.js 建立 API 的基礎知識。

什麼是 Express.js？
Express.js 是一個輕量級框架，用於使用 Node.js 建立伺服器端應用程式。它簡化了處理 HTTP 請求、路由和中間件整合等任務，使其成為建立 API 的絕佳選擇。

為什麼要使用 Express.js？

• 易於使用：語法簡單，設定快速。
• 靈活性：可使用中間件進行客製化，以新增身份驗證、日誌記錄和錯誤處理等功能。
• 可擴充性：適用於小型和大型應用程式。

設定 Express.js 環境

第 1 步：安裝 Node.js
確保您已安裝 Node.js。如有需要，請從nodejs.org下載。

第 2 步：初始化您的專案
建立一個新的專案目錄並初始化它：

mkdir express-api  
cd express-api  
npm init -y 

這將建立一個 package.json 檔案來管理相依性。

第 3 步：安裝 Express.js
使用 npm 安裝 Express.js：

npm install express  

建立您的第一個 API

第 1 步：建立基本伺服器
首先建立一個 server.js 檔案並加入以下程式碼：

const express = require('express');  
const app = express();  
const PORT = 3000;  

app.listen(PORT, () => {  
  console.log(`Server is running on http://localhost:${PORT}`);  
});  

使用以下命令運行伺服器：

node server.js 

造訪http://localhost:3000，你會看到伺服器正在運作（儘管它還不會回傳任何內容）。

第 2 步：定義您的第一條路線
路由定義您的 API 如何回應客戶端請求。新增一個簡單的路由來傳回歡迎訊息：

app.get('/', (req, res) => {  
  res.send('Welcome to your first Express API!');  
});  

重新啟動伺服器，造訪 http://localhost:3000 現在將顯示該訊息。

第 3 步：建立 API 端點
讓我們新增一個端點來處理資料。例如，傳回使用者清單的 /users 路由：

const users = [  
  { id: 1, name: 'Alice' },  
  { id: 2, name: 'Bob' },  
  { id: 3, name: 'Charlie' }  
];  

app.get('/users', (req, res) => {  
  res.json(users);  
}); 

造訪 http://localhost:3000/users 現在將傳回 JSON 格式的使用者資料。

加入中間件
Express.js 中的中間件函數處理請求和回應。例如，您可以使用中間件來解析客戶端傳送的 JSON 資料。

第 1 步：使用內建中間件
若要啟用 JSON 解析，請新增以下內容：

app.use(express.json());  

第 2 步：處理 POST 請求
新增建立新使用者的路線：

mkdir express-api  
cd express-api  
npm init -y 

現在您可以向 http://localhost:3000/users 發送帶有 JSON 資料的 POST 請求來新增使用者。

錯誤處理
要優雅地處理錯誤，請使用中間件。例如：

npm install express  

這可確保任何未處理的錯誤回傳有意義的回應。

最終程式碼
這是完整的範例：

const express = require('express');  
const app = express();  
const PORT = 3000;  

app.listen(PORT, () => {  
  console.log(`Server is running on http://localhost:${PORT}`);  
});  

結論
Express.js 讓建置 API 變得簡單而高效，提供了快速入門所需的工具和靈活性。透過了解設定路由、處理資料和使用中間件的基礎知識，您可以為您的 Web 應用程式建立強大的 API。

繼續探索身份驗證、資料庫整合和進階錯誤處理等功能，將您的 API 提升到新的水平！

以上是使用 Express.js 建立 API 的初學者指南的詳細內容。更多資訊請關注PHP中文網其他相關文章！