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

REST API設計的六個支柱

六個REST API原則：

(1) 客戶端-服務器架構： 這個原則將用戶界面關注點與數據存儲關注點分離，通過簡化服務器組件從而提高界面在各平臺上的可移植性，并通過簡化服務器組件來增強可伸縮性。

(2) 狀態無關交互： 每個客戶端到服務器的請求必須包含理解和處理請求所需的所有信息。服務器不存儲有關客戶端的任何會話信息。

(3) 可緩存的響應： 在REST中，響應必須定義為可緩存或不可緩存。這意味著客戶端可以將來等效請求的響應數據進行重用，減輕服務器負載并提高應用程序的效率。

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

(5) 按需代碼： 服務器可以通過傳輸可執行代碼(例如Java小程序或JavaScript)來擴展客戶端的功能。

(6) 統一接口： 此約束簡化并解耦架構，使每個部分能夠獨立發展。一致接口的四個指導原則是請求中的資源標識、通過表示操作資源、自描述消息和超媒體作為應用程序狀態引擎(HATEOAS)。

• 自描述消息： 每個來自客戶端的消息都帶有詳細的說明，就像一份精心編寫的食譜，準確告訴服務器要做什么。
• 基于資源： 資源是API世界的名詞，如用戶、照片、細節，通過URI在請求中進行標識，就像互聯網上的地址一樣。
• 通過表示操作： 當客戶端獲取資源的表示時，它獲取了修改或刪除資源所需的所有詳細信息，假設具有權限。

理解這些原則至關重要，因為它們構成了RESTful API建立和運行的基礎。

解剖URI

在快節奏的Web開發世界中，REST API就像數字體內錯綜復雜的血管網絡一樣重要。它們對于客戶端(如瀏覽器或移動應用)與服務器(數據存儲的地方)之間的通信至關重要。讓我們通過一個實際示例來揭示URI(統一資源標識符)的元素：

(1) HTTP方法：互聯網的動詞

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

(2) 協議：參與規則

HTTPS： HTTPS是HTTP的安全版本，使用TLS加密。這是Web服務的黃金標準，保護登錄憑據、支付信息和個人數據等敏感數據。最佳實踐是默認使用HTTPS以確保數據的完整性和保密性。

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

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

(4) 子域：圖書館中的特定過道

api： 子域是組織在線存在的一種很好的方式。使用它們來命名業務的不同區域，分離應用程序環境，簡化訪問控制，幫助可伸縮性并控制Cookie和會話。只是要注意搜索引擎可能會將子域視為獨立的網站。

(5) 端點：流派部分

/users： 端點是表示API的唯一功能或資源的特定URI。它們應該設計得直觀、清晰且在所有端點上保持一致。資源命名應該使用名詞，并邏輯上表示層次結構和關系。復雜查詢應通過查詢參數處理。精心設計的端點對于高效、用戶友好的API至關重要，就像商場中井然有序的商店提供愉快的購物體驗一樣。

(6) 分頁：索引頁面

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

(7) 過濾：圖書館查詢

?age=25&gender=male： 過濾是一種請求滿足特定標準的數據的方法。這就像要求知識淵博的導游只向您展示在大型市場中滿足您需求的物品一樣。為了有效地實施過濾，使用查詢參數、清晰一致的命名、支持多個過濾器、高效地查詢數據庫并記錄可用的過濾器。API中的過濾簡化了數據檢索過程，使其高效且用戶友好。通過允許客戶端過濾和排序數據，減少了帶寬使用并提高了相關性。

通過理解這些URI組件，您正在掌握REST API的藝術。它們是指引數據流動的路標和工具，確保您能夠找到并與您需要的信息進行交互。

• 設計 您的API以反映您的域或數據庫架構，創建自然而直觀的結構。
• 密切關注您的API的性能，使用響應時間和狀態代碼等指標確保最佳運行。
• 實施強大的身份驗證和授權機制，明智地管理CORS，強制執行TLS，實踐冪等操作，嚴格驗證輸入，限制請求速率，并記錄活動而不 compromi敏感數據。