REST API是數(shù)字世界的關(guān)鍵組成部分，使不同的應(yīng)用程序和系統(tǒng)能夠無(wú)縫地相互通信。我們的旅程將從深入探討REST API架構(gòu)的六個(gè)基本原則開(kāi)始。這些原則包括客戶(hù)端-服務(wù)器架構(gòu)、狀態(tài)無(wú)關(guān)性、可緩存性、分層系統(tǒng)、統(tǒng)一接口和按需代碼。閱讀至文章末尾獲取速查表。

REST API設(shè)計(jì)的六個(gè)支柱

六個(gè)REST API原則：

(1) 客戶(hù)端-服務(wù)器架構(gòu)： 這個(gè)原則將用戶(hù)界面關(guān)注點(diǎn)與數(shù)據(jù)存儲(chǔ)關(guān)注點(diǎn)分離，通過(guò)簡(jiǎn)化服務(wù)器組件從而提高界面在各平臺(tái)上的可移植性，并通過(guò)簡(jiǎn)化服務(wù)器組件來(lái)增強(qiáng)可伸縮性。

(2) 狀態(tài)無(wú)關(guān)交互： 每個(gè)客戶(hù)端到服務(wù)器的請(qǐng)求必須包含理解和處理請(qǐng)求所需的所有信息。服務(wù)器不存儲(chǔ)有關(guān)客戶(hù)端的任何會(huì)話信息。

(3) 可緩存的響應(yīng)： 在REST中，響應(yīng)必須定義為可緩存或不可緩存。這意味著客戶(hù)端可以將來(lái)等效請(qǐng)求的響應(yīng)數(shù)據(jù)進(jìn)行重用，減輕服務(wù)器負(fù)載并提高應(yīng)用程序的效率。

(4) 分層系統(tǒng)： 系統(tǒng)通常以具有特定功能的層組織，使得客戶(hù)端難以判斷它們是直接連接到最終服務(wù)器還是中間服務(wù)器。

(5) 按需代碼： 服務(wù)器可以通過(guò)傳輸可執(zhí)行代碼(例如Java小程序或JavaScript)來(lái)擴(kuò)展客戶(hù)端的功能。

(6) 統(tǒng)一接口： 此約束簡(jiǎn)化并解耦架構(gòu)，使每個(gè)部分能夠獨(dú)立發(fā)展。一致接口的四個(gè)指導(dǎo)原則是請(qǐng)求中的資源標(biāo)識(shí)、通過(guò)表示操作資源、自描述消息和超媒體作為應(yīng)用程序狀態(tài)引擎(HATEOAS)。

• 自描述消息： 每個(gè)來(lái)自客戶(hù)端的消息都帶有詳細(xì)的說(shuō)明，就像一份精心編寫(xiě)的食譜，準(zhǔn)確告訴服務(wù)器要做什么。
• 基于資源： 資源是API世界的名詞，如用戶(hù)、照片、細(xì)節(jié)，通過(guò)URI在請(qǐng)求中進(jìn)行標(biāo)識(shí)，就像互聯(lián)網(wǎng)上的地址一樣。
• 通過(guò)表示操作： 當(dāng)客戶(hù)端獲取資源的表示時(shí)，它獲取了修改或刪除資源所需的所有詳細(xì)信息，假設(shè)具有權(quán)限。

理解這些原則至關(guān)重要，因?yàn)樗鼈儤?gòu)成了RESTful API建立和運(yùn)行的基礎(chǔ)。

解剖URI

在快節(jié)奏的Web開(kāi)發(fā)世界中，REST API就像數(shù)字體內(nèi)錯(cuò)綜復(fù)雜的血管網(wǎng)絡(luò)一樣重要。它們對(duì)于客戶(hù)端(如瀏覽器或移動(dòng)應(yīng)用)與服務(wù)器(數(shù)據(jù)存儲(chǔ)的地方)之間的通信至關(guān)重要。讓我們通過(guò)一個(gè)實(shí)際示例來(lái)揭示URI(統(tǒng)一資源標(biāo)識(shí)符)的元素：

(1) HTTP方法：互聯(lián)網(wǎng)的動(dòng)詞

• GET 求知者： 使用GET請(qǐng)求檢索服務(wù)器數(shù)據(jù)，就像向圖書(shū)館員詢(xún)問(wèn)一本書(shū)一樣。GET請(qǐng)求應(yīng)該是安全和冪等的，這意味著多次發(fā)出請(qǐng)求不會(huì)導(dǎo)致額外的副作用或服務(wù)器狀態(tài)更改。
• POST：創(chuàng)作者： POST請(qǐng)求創(chuàng)建新資源。在客戶(hù)端請(qǐng)求服務(wù)器處理請(qǐng)求正文中包含的資源時(shí)，使用POST是必要的。成功的響應(yīng)將返回一個(gè)包含指向新創(chuàng)建資源的鏈接的201 Created狀態(tài)的Location標(biāo)頭。
• PUT 優(yōu)秀的編輯者： PUT請(qǐng)求更新現(xiàn)有資源或在特定URL上創(chuàng)建它們(如果它們不存在)。它們是冪等的，因此多次發(fā)送相同的請(qǐng)求會(huì)產(chǎn)生與發(fā)送一次相同的結(jié)果。
• PATCH：微調(diào)器： PATCH部分更新資源，就像糾正整本書(shū)而不改變整本書(shū)一樣。它有時(shí)是冪等的，但最好在可能的情況下以這種方式實(shí)現(xiàn)。
• DELETE 記錄橡皮擦： DELETE請(qǐng)求從服務(wù)器的庫(kù)中刪除資源。它們應(yīng)該是冪等的，后續(xù)請(qǐng)求應(yīng)該返回404 Not Found狀態(tài)代碼。

(2) 協(xié)議：參與規(guī)則

HTTPS： HTTPS是HTTP的安全版本，使用TLS加密。這是Web服務(wù)的黃金標(biāo)準(zhǔn)，保護(hù)登錄憑據(jù)、支付信息和個(gè)人數(shù)據(jù)等敏感數(shù)據(jù)。最佳實(shí)踐是默認(rèn)使用HTTPS以確保數(shù)據(jù)的完整性和保密性。

(3) 版本控制：保持章節(jié)有序

/v1： API版本控制對(duì)于在不中斷服務(wù)的情況下管理更新至關(guān)重要。保持一致的版本控制策略，并具有清晰的棄用政策。每個(gè)版本都應(yīng)有文檔，并且用戶(hù)應(yīng)該被告知新版本。避免過(guò)度版本化，為重大更改保留新版本。版本控制是與用戶(hù)建立的一種契約，承諾在繼續(xù)發(fā)展技術(shù)的同時(shí)保持穩(wěn)定性。

(4) 子域：圖書(shū)館中的特定過(guò)道

api： 子域是組織在線存在的一種很好的方式。使用它們來(lái)命名業(yè)務(wù)的不同區(qū)域，分離應(yīng)用程序環(huán)境，簡(jiǎn)化訪問(wèn)控制，幫助可伸縮性并控制Cookie和會(huì)話。只是要注意搜索引擎可能會(huì)將子域視為獨(dú)立的網(wǎng)站。

(5) 端點(diǎn)：流派部分

/users： 端點(diǎn)是表示API的唯一功能或資源的特定URI。它們應(yīng)該設(shè)計(jì)得直觀、清晰且在所有端點(diǎn)上保持一致。資源命名應(yīng)該使用名詞，并邏輯上表示層次結(jié)構(gòu)和關(guān)系。復(fù)雜查詢(xún)應(yīng)通過(guò)查詢(xún)參數(shù)處理。精心設(shè)計(jì)的端點(diǎn)對(duì)于高效、用戶(hù)友好的API至關(guān)重要，就像商場(chǎng)中井然有序的商店提供愉快的購(gòu)物體驗(yàn)一樣。

(6) 分頁(yè)：索引頁(yè)面

?page=2&limit=10： 分頁(yè)將龐大的數(shù)據(jù)集分解為較小、編號(hào)的部分(頁(yè)面)，使數(shù)據(jù)檢索變得可管理和用戶(hù)友好。使用標(biāo)準(zhǔn)參數(shù)，提供導(dǎo)航鏈接，確保一致的排序，并提供總計(jì)和頁(yè)面元數(shù)據(jù)。通過(guò)使用分頁(yè)，API確保信息是可訪問(wèn)的，檢索信息的體驗(yàn)愉快，就像在井然有序的圖書(shū)館中找到合適的書(shū)一樣。

(7) 過(guò)濾：圖書(shū)館查詢(xún)

?age=25&gender=male： 過(guò)濾是一種請(qǐng)求滿(mǎn)足特定標(biāo)準(zhǔn)的數(shù)據(jù)的方法。這就像要求知識(shí)淵博的導(dǎo)游只向您展示在大型市場(chǎng)中滿(mǎn)足您需求的物品一樣。為了有效地實(shí)施過(guò)濾，使用查詢(xún)參數(shù)、清晰一致的命名、支持多個(gè)過(guò)濾器、高效地查詢(xún)數(shù)據(jù)庫(kù)并記錄可用的過(guò)濾器。API中的過(guò)濾簡(jiǎn)化了數(shù)據(jù)檢索過(guò)程，使其高效且用戶(hù)友好。通過(guò)允許客戶(hù)端過(guò)濾和排序數(shù)據(jù)，減少了帶寬使用并提高了相關(guān)性。

通過(guò)理解這些URI組件，您正在掌握REST API的藝術(shù)。它們是指引數(shù)據(jù)流動(dòng)的路標(biāo)和工具，確保您能夠找到并與您需要的信息進(jìn)行交互。

• 設(shè)計(jì) 您的API以反映您的域或數(shù)據(jù)庫(kù)架構(gòu)，創(chuàng)建自然而直觀的結(jié)構(gòu)。
• 密切關(guān)注您的API的性能，使用響應(yīng)時(shí)間和狀態(tài)代碼等指標(biāo)確保最佳運(yùn)行。
• 實(shí)施強(qiáng)大的身份驗(yàn)證和授權(quán)機(jī)制，明智地管理CORS，強(qiáng)制執(zhí)行TLS，實(shí)踐冪等操作，嚴(yán)格驗(yàn)證輸入，限制請(qǐng)求速率，并記錄活動(dòng)而不 compromi敏感數(shù)據(jù)。