const app = express();
app.use(express.json()); // 解析 JSON 請求體的中間件

app.listen(3000, () => console.log('Server running on port 3000'));

上述代碼完成了以下操作:

運行該應用程序后,服務器將啟動,但尚未提供供用戶使用的 API 端點。接下來,將實現用戶可利用的端點。

第 4 步:實施 RESTful 端點

創建 API 時,擁有多個端點以實現各種任務是合理的。需使用之前介紹的 CRUD API 的 HTTP 方法(如 GET、POST、PUT、DELETE),每種方法對應不同的 CRUD 操作。以下是每種類型端點的示例,可在 Express 項目中的 app.use() 語句之后添加并執行此代碼。

獲取端點

實現從服務器獲取數據的 GET 端點。以下代碼展示了此類端點的基本結構:

app.get('/api/items', (req, res) => {
res.send('List of items');
});

app.get(...) 語句中,定義了 GET 路由。當向 /api/items 發出 GET 請求時,將執行回調函數。上述示例使用 res.send() 返回一個字符串。在功能更強大的端點中,可能會訪問數據庫等資源并返回數據。

發布端點

實現 POST 端點,該端點包含向服務器添加新數據的邏輯。以下代碼展示了此類端點的結構:

app.post('/api/items', (req, res) => {
const newItem = req.body; // 請求體中發送的數據
res.send(Item added: ${newItem.name}); });

在上述代碼中,app.post(...) 函數處理 POST 請求。req.body 包含請求中發送的數據,并在響應中返回。在功能更強大的端點中,可能會在此處執行將數據寫入數據庫的邏輯。創建新記錄后,可發送一個布爾值,例如 created: true,或新創建實體的 ID。

更新端點

創建用于更新現有數據的 PUT 端點。以下代碼展示了 PUT 端點的基本結構:

app.put('/api/items/:id', (req, res) => {
const itemId = req.params.id; // 訪問 URL 參數
res.send(Item with ID ${itemId} updated); });

在上述代碼中,app.put(...) 處理 PUT 請求。要更新的資源的 ID 通常作為查詢參數或 URI 參數傳遞。通過 req.params.id 獲取 ID 參數。在實際實現中,通常使用請求正文中的數據進行數據庫調用以更新資源,然后返回一個布爾值,說明更新是否已處理。

刪除端點

展示從服務器刪除數據的 DELETE 端點的示例。以下代碼展示了 DELETE 端點在 Express 中的基本示例:

app.delete('/api/items/:id', (req, res) => {
const itemId = req.params.id;
res.send(Item with ID ${itemId} deleted); });

如上所示,app.delete(...) 方法處理 DELETE 請求。與 PUT 一樣,使用 req.params.id 確定要刪除的項目。與其他端點類似,可能會向數據庫發出請求,以刪除指定資源。

第 5 步:測試 API

構建 API 后,下一步是在本地系統上啟動并運行,并使用 Postman 進行測試。以下是部署和測試端點的各個步驟,從啟動 Node.js 服務器開始。

設置并運行 API
確保 Node.js 服務器正在運行才能訪問 API 端點。通常,通過在終端(指向項目根目錄)中執行 node server.js 命令來啟動并運行服務器。

配置 Postman
下載并安裝 Postman(或 Insomnia)以向端點發出請求進行測試。首先,安裝 Postman。如果尚未安裝,請從官方網站下載。安裝后,創建一個請求:打開 Postman,點擊“新建”,然后點擊“請求”,并將其保存到新的或現有的集合中。

測試 API 端點
使用所選的適當方法(如 GET、POST、PUT 或 DELETE)向每個端點發出請求。以下是每種方法類型的具體信息:

分析響應
測試每個端點時,檢查 Postman 中每個請求的響應是否正確。成功的操作通常會返回狀態代碼,如 200(正常)或 201(已創建)。如出現錯誤,使用響應詳細信息和服務器控制臺日志進行調試。如果端點正在更改數據庫中的資源,還需檢查是否發生了正確的操作。

添加 API 分析和貨幣化

構建 API 只是一個開始。創建 API 端點后,除了使用 API 測試工具之外,還需要監控和分析傳入流量。這有助于識別潛在問題和安全缺陷,并了解 API 的使用情況,這些都是 API 發展的關鍵方面。

隨著 API 平臺的發展,可能會開始專注于創建 API 產品。通過專注于 API 產品,API 從簡單的構建轉變為業務工具和收入來源。與更正式的產品類似,API 產品需要管理并可能被貨幣化。通過 API 增加收入是擴大業務利潤的有效途徑。

結論

至此,介紹了構建 REST API 的基礎知識。本篇文章中,使用 Node.js 和 Express 構建了一些可擴展的簡單端點。總體而言,提供的代碼為應用程序構建 API 提供了良好的起點。

構建 API 后,可能希望開始分析 API 的使用情況并從中獲利。在這些情況下,合適的工具可以幫助實現 API 分析和貨幣化,支持更好的 API 開發與管理。

原文鏈接:Rest API Tutorial – A Complete Beginner’s Guide

上一篇:

探索 Flink SQL Gateway REST API

下一篇:

使用NestJS和Prisma構建REST API:身份驗證
#你可能也喜歡這些API文章!

我們有何不同?

API服務商零注冊

多API并行試用

數據驅動選型,提升決策效率

查看全部API→
??

熱門場景實測,選對API

#AI文本生成大模型API

對比大模型API的內容創意新穎性、情感共鳴力、商業轉化潛力

25個渠道
一鍵對比試用API 限時免費

#AI深度推理大模型API

對比大模型API的邏輯推理準確性、分析深度、可視化建議合理性

10個渠道
一鍵對比試用API 限時免費