API Proxy 開發的要點

您正在查看 Apigee Edge 說明文件。
查看 Apigee X 說明文件
資訊

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

API 是應用程式可使用另一個功能的進入點。實作 API Proxy 來建立 API

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

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

如需 API Proxy 總覽,請參閱瞭解 API 和 API Proxy

您可以利用流程排列 API Proxy 邏輯的順序

在任何應用程式中,資料都會以條件邏輯引導的應用程式傳輸。在 Apigee Edge 中,處理路徑是由資料流組成。流程是一組階段 (或「步驟」),構成 API Proxy 的處理路徑。「流程」是 Apigee Edge 提供的途徑,可讓您先在用戶端、後端資源等特定位置套用邏輯和行為,然後再傳回用戶端。

如要進一步瞭解流程,請參閱控管 Proxy 透過資料流執行的方式一文

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

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

這些變數是由 Apigee Edge 保存。根據預設,部分程式庫是主要的,通常因為 API Proxy 的作用很常見 (例如,這是 HTTP 要求的一部分)。您也可以建立自己的變數來滿足邏輯要求。

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

您可以讓 API Proxy 有條件地執行

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

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

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

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

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

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

如果 API Proxy 包含程式碼中多個位置 (例如其他 API Proxy) 使用的邏輯,您可以收集來自多個位置的呼叫邏輯。舉例來說,您可以將安全性邏輯分組,並納入其他 API Proxy 呼叫的共用流程,藉此減少 API Proxy 的重複情形。

如要進一步瞭解共用流程,請參閱可重複使用的共用流程。如要進一步瞭解 API Proxy 鏈結,請參閱將 API Proxy 鏈結在一起

您可以使用追蹤工具對 Proxy 進行偵錯

Apigee Edge 提供一項追蹤記錄工具,可讓您在偵錯和測試時檢查 API Proxy 的執行流程。這項工具會以視覺化方式呈現針對要求執行的每個 API Proxy 步驟。如同偵錯工具,您可以在每個步驟中,查看組成 API Proxy 狀態的變數值清單。

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

將 API Proxy 錯誤視為錯誤處理

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

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