REST 和 RESTful API 簡介

在現(xiàn)代 Web 開發(fā)中，你一定經(jīng)常遇到 REST 和 API 這些術(shù)語。如果你聽說過這些術(shù)語或使用過 API，但并不完全了解它們的工作原理或如何構(gòu)建自己的 API，那么本系列教程正適合你。

本教程系列將首先概述 REST 原則和概念。然后，我們將創(chuàng)建一個(gè)在 Node.js Express 服務(wù)器上運(yùn)行并連接到 MySQL 數(shù)據(jù)庫的完整 API。完成本系列教程后，你應(yīng)該能夠自信地構(gòu)建自己的 API 或深入研究現(xiàn)有 API 的文檔。

先決條件

為了充分利用本教程，你應(yīng)該具備一些基本的命令行知識(shí)，了解 JavaScript 的基礎(chǔ)知識(shí)，并在全局安裝了 Node.js。

REST 和 RESTful API 是什么？

表述性狀態(tài)轉(zhuǎn)移 (REST) 描述了一種 Web 服務(wù)的架構(gòu)風(fēng)格。REST 包含一組用于在不同系統(tǒng)之間共享數(shù)據(jù)的標(biāo)準(zhǔn)或約束，實(shí)現(xiàn) REST 的系統(tǒng)被稱為 RESTful。REST 是一個(gè)抽象概念，而不是一種語言、框架或軟件類型。

一個(gè)關(guān)于 REST 的松散類比是：保留黑膠唱片收藏與使用流媒體音樂服務(wù)。對(duì)于物理黑膠唱片收藏，必須完整復(fù)制每張唱片才能共享和分發(fā)副本。然而，對(duì)于流媒體服務(wù)，可以通過對(duì)某些數(shù)據(jù)（例如歌曲標(biāo)題）的引用來永久共享相同的音樂。在這種情況下，流媒體音樂是一種 RESTful 服務(wù)，而黑膠唱片收藏是一種非 RESTful 服務(wù)。

API 是應(yīng)用程序編程接口，它是一個(gè)允許軟件程序相互通信的接口。RESTful API 只是一個(gè)遵循 REST 原則和約束的 API。在 Web API 中，服務(wù)器通過 URL 端點(diǎn)接收請(qǐng)求，并返回響應(yīng)，響應(yīng)通常是 JSON 格式的數(shù)據(jù)。

REST 原則

六個(gè)指導(dǎo)性約束定義了 REST 架構(gòu)，如下所示：

1. 統(tǒng)一接口: 組件的接口必須相同。這意味著使用 URI 標(biāo)準(zhǔn)來標(biāo)識(shí)資源——換句話說，可以輸入到瀏覽器地址欄中的路徑。
2. 客戶端-服務(wù)器: 服務(wù)器（存儲(chǔ)和操作數(shù)據(jù)）和客戶端（請(qǐng)求和顯示響應(yīng)）之間存在關(guān)注點(diǎn)分離。
3. 無狀態(tài)交互: 關(guān)于每個(gè)請(qǐng)求的所有信息都包含在每個(gè)單獨(dú)的請(qǐng)求中，并且不依賴于會(huì)話狀態(tài)。
4. 可緩存: 客戶端和服務(wù)器可以緩存資源。
5. 分層系統(tǒng): 客戶端可以連接到最終服務(wù)器，或中間層，例如負(fù)載均衡器。
6. 按需代碼 (可選): 客戶端可以下載代碼，從而減少外部可見性。

請(qǐng)求和響應(yīng)

你可能已經(jīng)熟悉了所有網(wǎng)站的 URL 都以 https 開頭（安全版本）。超文本傳輸協(xié)議 (HTTP) 是互聯(lián)網(wǎng)上客戶端和服務(wù)器之間通信的方法。

我們最明顯地看到它在瀏覽器的 URL 欄中，但 HTTP 不僅可以用于從服務(wù)器請(qǐng)求網(wǎng)站。當(dāng)你訪問 Web 上的 URL 時(shí)，你實(shí)際上是在執(zhí)行 GET 和其他類型的請(qǐng)求。

HTTP 通過打開到服務(wù)器端口 (http、https) 的TCP (傳輸控制協(xié)議) 連接來發(fā)出請(qǐng)求，監(jiān)聽服務(wù)器會(huì)返回狀態(tài)和正文。

請(qǐng)求必須包含 URL、方法、標(biāo)頭信息和正文。

請(qǐng)求方法

有四種主要的 HTTP 方法，也稱為 HTTP 動(dòng)詞，通常用于與 Web API 交互。這些方法定義了將對(duì)任何給定資源執(zhí)行的操作。

HTTP 請(qǐng)求方法大致對(duì)應(yīng)于CRUD 范例，CRUD 代表 創(chuàng)建、更新、讀取、刪除。盡管 CRUD 指的是數(shù)據(jù)庫操作中使用的函數(shù)，但我們可以將這些設(shè)計(jì)原則應(yīng)用于 RESTful API 中的 HTTP 動(dòng)詞。

<code>curl -i https://www.google.com</code>

Google 的服務(wù)器將返回以下內(nèi)容：

<code>HTTP/2 200
date: Sun, 21 Aug 2022 19:06:22 GMT
expires: -1
cache-control: private, max-age=0
content-type: text/html; charset=ISO-8859-1
...</code>

我們可以看到 200 狀態(tài)代碼，以及 HTTP 的版本（這將是 HTTP/1.1、HTTP/2 或 HTTP/3）。

由于此特定請(qǐng)求返回的是網(wǎng)站，因此為 text/html。在 RESTful API 中，你可能會(huì)看到對(duì) Google 的 curl 請(qǐng)求（不包含 google.com）返回 301 響應(yīng)，以指示應(yīng)重定向資源。

REST API 端點(diǎn)

當(dāng)在服務(wù)器上創(chuàng)建 API 時(shí)，它包含的數(shù)據(jù)可以通過端點(diǎn)訪問。端點(diǎn)是可以接受和處理 POST、DELETE 請(qǐng)求的請(qǐng)求的 URL。

API URL 將由根、路徑和可選查詢字符串組成。

• 根 例如 http://miracleart.cn/link/9efa87e164995a7743eca9ad63029fa4 的根，可能包含協(xié)議、域名和版本。
• 路徑 例如 /users/5：特定資源的唯一位置。
• 查詢參數(shù) (可選) 例如 limit=10，用于將響應(yīng)過濾為僅包含十個(gè)結(jié)果。

例如，要獲取 ID 為 5 的用戶，我們將使用 /user/5。

REST API 約定

以下是構(gòu)建 RESTful API 時(shí)應(yīng)遵循的一些約定：

• 端點(diǎn)不應(yīng)顯示文件擴(kuò)展名: 盡管 API 最有可能返回 JSON，但 URL 不應(yīng)以 .json 結(jié)尾。
• 使用名詞而不是動(dòng)詞: 例如，要添加用戶，我們應(yīng)該使用 /users 端點(diǎn)并使用 POST 請(qǐng)求，而不是使用 /users/add 端點(diǎn)。API 應(yīng)該開發(fā)為能夠處理對(duì)同一 URL 的多種類型的請(qǐng)求。
• 路徑區(qū)分大小寫，應(yīng)使用小寫字母和連字符而不是下劃線: 例如，/users-list 比 /users_list 更可取。

所有這些約定都是指導(dǎo)原則，因?yàn)闆]有嚴(yán)格的 REST 標(biāo)準(zhǔn)可供遵循。但是，使用這些指導(dǎo)原則將使你的 API 一致、熟悉且易于閱讀和理解。

REST 的替代方案

REST 是一種很棒的工具，但有一些替代方案可以在某些情況下提供幫助。

SOAP

SOAP（簡單對(duì)象訪問協(xié)議）是 1998 年創(chuàng)建的 API，在 REST 之前非常流行。它們之間存在一些主要區(qū)別。首先，SOAP 對(duì)響應(yīng)格式的限制要嚴(yán)格得多。其次，SOAP 使用 XML 而不是 JSON，這對(duì)于遺留應(yīng)用程序可能很有用，但通常比等效的 JSON 更大更復(fù)雜。最后，雖然 SOAP 可以很好地與 HTTP 配合使用，但它也支持 SMTP 等協(xié)議。

GraphQL

GraphQL 是 Facebook 創(chuàng)建的一種較新的 API 格式，它旨在通過允許客戶端準(zhǔn)確地告訴服務(wù)器它需要什么數(shù)據(jù)來減少獲取數(shù)據(jù)所需的 HTTP 請(qǐng)求數(shù)量。GraphQL 不使用 URL 路徑，而是具有自定義語法來定義客戶端需要什么數(shù)據(jù)，以便客戶端在一個(gè)請(qǐng)求中獲得所需的一切。

有關(guān) GraphQL 的精彩介紹，請(qǐng)查看本 GraphQL 教程。

結(jié)論

在本文中，我們學(xué)習(xí)了 REST 和 RESTful API 是什么，HTTP 請(qǐng)求方法和響應(yīng)代碼如何工作，API URL 的結(jié)構(gòu)以及常見的 RESTful API 約定。在下一教程中，我們將學(xué)習(xí)如何通過使用 Node.js 設(shè)置 Express 服務(wù)器并構(gòu)建我們自己的 API 來將所有這些理論付諸實(shí)踐。

本文已更新，并包含 Jacob Jackson 的貢獻(xiàn)。Jacob 是一位 Web 開發(fā)人員、技術(shù)作家、自由職業(yè)者和開源貢獻(xiàn)者。

以上是用node.js和express代碼您的第一個(gè)API：了解REST API的詳細(xì)內(nèi)容。更多信息請(qǐng)關(guān)注PHP中文網(wǎng)其他相關(guān)文章！