API Proxy 開發的要點

本頁內容適用於 ApigeeApigee Hybrid

查看 Apigee Edge 說明文件。

本主題列出 API Proxy 的一些基本特徵,並提供更多資訊的連結。

API 是應用程式的進入點,可讓應用程式使用其他應用程式的功能。您會實作 API Proxy 來建立 API

在 Apigee 中,您可以將 API Proxy 邏輯設定為一系列步驟,在回應用戶端程式碼的要求時執行,藉此實作 API Proxy。您定義的端點會包含網址和資源路徑、HTTP 動詞、主體需求等,藉此向用戶端公開 API Proxy。

雖然稱為 API Proxy,但從用戶端程式碼的角度來看,這就是 API

如要瞭解 API Proxy 的總覽,請參閱「瞭解 API 和 API Proxy」。

您可以使用流程安排 API Proxy 邏輯的順序

在任何應用程式中,資料都會根據條件邏輯流經應用程式。在 Apigee 中,處理路徑是由流程組成。流程是一連串的階段 (或「步驟」),構成 API Proxy 的處理路徑。Apigee 會提供流程,讓您在從用戶端到後端資源,然後再回到用戶端的特定位置套用邏輯和行為。

如要進一步瞭解流程,請參閱「使用流程控制 Proxy 的執行方式

透過 API Proxy 建立的流程變數存取狀態資料

API Proxy 可以存取代表執行狀態的變數。您可以從設定 API 代理和政策的 XML 存取這些變數。您也可以使用程序語言 (例如 Java、JavaScript 或 Python) 擴充 API 代理時存取這些變數。

這些變數由 Apigee 保留。有些是預設存在,通常是因為這些標頭是 API Proxy 的常見標頭 (例如屬於 HTTP 要求的一部分)。您也可以建立自己的變數,滿足邏輯需求。

如要進一步瞭解變數,請參閱「使用流程變數管理 Proxy 狀態」。

您可以讓 API Proxy 執行條件式

與大多數程式設計語言一樣,您可以在 API Proxy 中有條件地執行程式碼。條件通常是以 API Proxy 狀態為依據,您可以透過流程變數存取這些狀態。舉例來說,您可以設定條件來檢查使用者代理程式,然後據此處理要求。

如要進一步瞭解條件式執行,請參閱「含有流程變數的條件」。

您可以使用政策,在 API Proxy 中實作大部分的邏輯

您新增至 API Proxy 的大部分邏輯都會封裝為政策。政策是 Apigee 元件,可封裝功能領域的邏輯,例如安全性或流量管理。您可以使用 XML 設定政策,為基礎邏輯設定屬性。您可以在流程中依「步驟」順序安排政策,讓 API Proxy 以最適合 Proxy 目標的順序執行邏輯。

如要進一步瞭解政策,請參閱「什麼是政策?」一文。

您可以納入可重複使用的功能集

如果 API Proxy 包含的邏輯會用於程式碼中的多個位置 (例如其他 API Proxy),您可以收集該邏輯,以便從多個位置呼叫。舉例來說,您可以將安全性邏輯歸入其他 API Proxy 呼叫的共用流程,減少 API Proxy 之間的重複作業。

如要進一步瞭解共用流程,請參閱「可重複使用的共用流程」。如要進一步瞭解如何鏈結 API Proxy,請參閱「鏈結多個 API Proxy」。

您可以使用偵錯工具偵錯 Proxy

Apigee 包含 Debug 工具,可用於偵錯及測試時檢查 API Proxy 的執行流程。這項工具會以視覺化方式呈現要求執行的每個 API Proxy 步驟。如同偵錯工具,您可以在每個步驟查看組成 API 代理狀態的變數值清單。

如要進一步瞭解如何使用偵錯工具進行偵錯,請參閱「偵錯工具」。

您將 API Proxy 錯誤視為故障

設定錯誤處理常式後,您就能自訂傳回 API 用戶端的錯誤。無論錯誤是源自於您自己的程式碼,還是來自於內含的元件 (例如政策),您都可以透過錯誤處理常式控管錯誤訊息。

詳情請參閱「處理錯誤」。