API Proxy 開發的要點

本頁適用於 ApigeeApigee Hybrid

查看 Apigee Edge 說明文件。

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

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

在 Apigee 中,您可以將 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 Proxy 時存取這些值。

這些變數由 Apigee 保管。有些預設存在,通常是因為這些屬性與 API 代理程式執行的動作相似 (例如屬於 HTTP 要求的一部分)。您也可以自行建立變數,以滿足邏輯需求。

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

您可以讓 API Proxy 依條件執行

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

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

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

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

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

您可以加入可重複使用的功能組合

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

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

您可以使用「Debug」工具偵錯 Proxy

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

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

您會將 API Proxy 錯誤視為錯誤

您可以設定錯誤處理常式,自訂傳回至 API 用戶端的錯誤。錯誤處理程序可讓您控制錯誤訊息,無論錯誤是來自您自己的程式碼,還是來自所包含的元件 (例如政策)。

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