使用流程掛鉤附加共用的流程

您目前查看的是 Apigee Edge 說明文件。
前往 Apigee X 說明文件。 info

您可以讓共用流程在一組 API 中執行樣板要求前置處理或回應後置處理。您可以使用流程掛鉤附加共用流程，讓部署至特定環境的所有 API Proxy 在相同位置執行共用流程。這樣一來，您就能取得獨立實作及部署的邏輯序列，不屬於 Proxy 的實作程式碼。

由於附加至流程掛鉤的程式碼位於 API Proxy 核心邏輯的環境外，因此部分行為與 API Proxy 不同。請注意以下幾點：

  • 您必須具備將共用流程附加至流程掛鉤的權限。你必須是機構管理員。
  • 每個流程掛鉤只能附加一個共用流程。
  • 您可以將同一個共用流程附加至多個流程掛鉤。
  • 如果附加至流程掛鉤的共用流程引發錯誤，或共用流程執行期間發生錯誤，系統會拒絕訊息，並將錯誤傳回給呼叫端。
  • 如果訊息在執行流程掛鉤時遭到拒絕，系統會將詳細資料記錄到所呼叫 Proxy 的 Analytics 中。共用流程也可以擲回含有自訂代碼和錯誤訊息的錯誤

以下影片說明如何在傳統 Edge 使用者介面中，將共用流程連結至流程掛鉤，然後追蹤該流程。

以下影片示範如何在 New Edge 體驗的 UI 中，將共用流程連結至流程掛鉤，然後追蹤該流程。

透過流程掛鉤附加至 Proxy 的共用流程，是執行邏輯的絕佳位置，可強制執行廣泛的政策規定。舉例來說，假設您有一個團隊負責管理多個團隊的一組安全性需求，而這些團隊代表不同的業務線 (LOB)。各業務部門團隊可以根據自身需求開發 API，不必考慮更廣泛的安全性需求。資安團隊可以在共用流程中導入這些安全防護機制需求，然後使用流程掛鉤，將流程附加至 Apigee Edge 環境。由於共用流程不屬於 Proxy 程式碼，因此安全團隊可視需要修訂共用流程，不會干擾 LOB 程式碼。

透過流程掛鉤附加的共用流程，會在部署至 Proxy 掛鉤環境的每個 API Proxy 中，於該位置執行。因此，只有 Apigee Edge 機構管理員才能使用流程掛鉤。

如要進一步瞭解共用流程，請參閱「可重複使用的共用流程」。

您可以使用 Apigee Edge 管理主控台，將共用流程附加至流程掛鉤。您可以在下列位置，將最多一個共用流程附加至流程掛鉤：

  • Pre-proxy Flow Hook：適用於需要在 Proxy 端點執行前強制執行的邏輯。

    舉例來說，您可以在環境中針對所有 API 強制執行安全性邏輯。

  • 目標前流程掛鉤：用於在呼叫目標前強制執行的邏輯。

    舉例來說，您可以在要求送達後端之前實作記錄功能。您也可以從要求中移除特定欄位，強制執行中介服務。

  • 目標後流程掛鉤：用於在目標回應執行後強制執行的邏輯。

    後端傳回回應後，系統會立即強制執行這項設定。您可以使用這個函式記錄後端回應，或從後端回應中移除敏感欄位，執行某種中介程序。

  • 後端 Proxy 流程掛鉤：用於在 Proxy 端點之後，且在將回應傳送給用戶端之前，強制執行的邏輯。

    這可能包括 CORS 的強制執行邏輯、記錄回應，或執行一些混搭或格式設定。

將共用流程附加至流程掛鉤

如要將共用流程附加至流程掛鉤，您必須是含有共用流程的機構管理員。

  1. 存取「流程 Hook」頁面，詳情請見下文。

    邊緣

    如要使用 Edge UI 存取「Flow Hooks」頁面，請按照下列步驟操作：

    1. 登入 apigee.com/edge。
    2. 選取含有共用流程的機構。請參閱「切換機構」。

      這個組織部署至環境的任何 API Proxy 和共用流程，都能使用共用流程。貴機構外部人員無法存取。

    3. 在左側導覽列中，依序選取「管理」>「環境」>「流程掛鉤」。

    Classic Edge (Private Cloud)

    如要使用傳統 Edge UI 存取「流程掛鉤」頁面，請按照下列步驟操作：

    1. 登入 http://ms-ip:9000，其中 ms-ip 是管理伺服器節點的 IP 位址或 DNS 名稱。
    2. 選取含有共用流程的機構。請參閱「切換機構」。

      這個組織部署至環境的任何 API Proxy 和共用流程，都能使用共用流程。貴機構外部人員無法存取。

    3. 在頂端導覽列中，依序選取「APIs」>「Environment Configuration」>「Flow Hooks」。
  2. 在流程掛鉤清單中，根據要執行共用流程的位置，找出要附加共用流程的流程掛鉤。
    Flow Hook Location 說明
    Pre-proxy 流程掛鉤 在 Proxy 端點執行「之前」
    目標前流程掛鉤 目標端點執行「之前」
    目標後流程掛鉤 目標回應執行「後」
    Post-proxy Flow Hook 在 Proxy 端點之後，且在將回應傳送給用戶端之前
  3. 將游標懸停在清單中的流程掛鉤上，即可顯示動作資料欄。
  4. 按一下「」。
  5. 在「共用流程」對話方塊中，從「共用流程」下拉式選單選取要附加的共用流程。
  6. 按一下「確定」。
  7. 視需要將共用流程附加至其他流程掛鉤。