反模式：在 API Proxy 中定義多個 ProxyEndpoint

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

ProxyEndpoint 設定可定義用戶端應用程式透過 Apigee Edge 使用 API 的方式。ProxyEndpoint 定義 API Proxy 的網址和 Proxy 行為：要套用的政策與要轉送的目標端點，以及執行這些政策或轉送規則須符合的條件。

簡單來說，ProxyEndpoint 設定會定義實作 API 需要完成的所有事項。

反模式

一個 API Proxy 可含有一或多個 Proxy 端點。定義多個 Proxy Endpoints 是簡單又簡單的機制，可讓您在單一 Proxy 中實作多個 API。如此一來，您就能在 TargetEndpoint 叫用前後，重複使用政策和/或商業邏輯。

另一方面，在單一 API Proxy 中定義多個 Proxy Endpoints 時，您會在概念上將許多不相關的 API 合併至單一成果。這會讓 API Proxy 更難以讀取、理解、偵錯及維護。這打破了 API Proxy 的主要理念，讓開發人員能夠更輕鬆地建立及維護 API。

影響程度

API Proxy 中的多個 ProxyEndpoint 可以：

  • 讓開發人員難以瞭解及維護 API Proxy。
  • 將數據分析模糊處理。根據預設，系統會匯總 Proxy 層級的數據分析資料。除非您建立自訂報表，否則系統不會依 Proxy 端點顯示指標細目。
  • 讓 API Proxy 問題難以排解。

最佳做法

當您實作新的 API Proxy 或重新設計現有 API Proxy 時，請使用下列最佳做法：

  1. 使用單一 ProxyEndpoint 實作一個 API Proxy。
  2. 如果有多個 API 共用通用目標伺服器，且/或需要目標伺服器的預先或叫用後邏輯相同，請考慮使用共用流程，在不同 API Proxy 中實作這類邏輯。
  3. 如果有多個 API 共用相同的起始基本路徑，但後置字串不同，請在單一 ProxyEndpoint 中使用條件式流程。
  4. 如果 API Proxy 有多個 Proxy 端點，且沒有任何問題，則無須採取任何行動。

每個 API Proxy 使用一個 ProxyEndpoint，有助於：

  1. 更簡便、易於維護 Proxy
  2. 系統會分別回報 Proxy 效能和目標回應時間等更好的 Analytics (分析) 資訊，而非匯總所有 Proxy 端點
  3. 更快的疑難排解與問題解決方式

其他資訊