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

您正在查看 Apigee Edge 說明文件。
前往 Apigee X 說明文件
info

您可以讓共用流程在一系列 API 中執行固定格式要求預處理或回應後處理作業。您可以使用流程掛鉤附加共用流程,讓系統在相同位置執行所有部署至特定環境的 API Proxy。這樣一來,您就能取得獨立實作及部署的邏輯序列,而這並非 Proxy 的實作程式碼。

由於附加至流程掛鉤的程式碼不在 API Proxy 核心邏輯的內容中,因此其部分行為與 API Proxy 不同。請注意以下幾點:

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

以下影片示範如何在 Edge 經典版 UI 中,將共用流程連結至流程掛鉤,然後追蹤流程。

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

透過流程掛鉤附加至 Proxy 的共用流程,可提供執行廣泛政策要求的邏輯。舉例來說,假設您有一個團隊負責管理一組安全性規定,適用於代表不同業務線 (LOB) 的多個團隊。每個 LOB 團隊都可以根據自身需求開發 API,而無須考量更廣泛的安全性需求。安全性團隊可以在共用流程中實作這些安全性需求,然後使用流程掛鉤將流程附加至 Apigee Edge 環境。由於共用流程不是 Proxy 程式碼的一部分,因此安全性團隊可以視需要修改,而不影響 LOB 程式碼。

透過流程掛鉤附加的共用流程,會在每個部署至 Proxy Hook 環境的 API Proxy 執行時執行。因此,只有 Apigee Edge 機構的管理員可以使用流程掛鉤。

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

您可以使用 Apigee Edge 管理控制台,將共用流程附加至流程掛鉤。您最多可在下列位置將一個共用流程連結至流程掛鉤:

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

    舉例來說,您可以建立邏輯,在環境中的所有 API 中強制執行安全性措施。

  • 目標前流程掛鉤:適用於需要在呼叫目標之前強制執行的邏輯。

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

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

    這項設定會在後端傳回回應後立即生效。您可以使用這項功能記錄後端回應,或從後端回應中移除敏感欄位,以便執行某些中介服務。

  • Post-proxy Flow Hook:用於執行 Proxy 端點之後,並在回應傳送至用戶端之前的邏輯。

    這可能包括 CORS 的部分強制執行邏輯、記錄回應,或執行部分混合或格式設定。

將共用流程連結至流程掛鉤

如要將共用動態流程附加至動態流程掛鉤,您必須是包含共用動態流程的機構中的管理員。

  1. 請按照下方說明存取「流程掛鉤」頁面。

    Edge

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

    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. 在頂端導覽列中,依序選取「API」>「環境設定」>「流程掛鉤」
  2. 在流程掛鉤清單中,根據要執行共用流程的位置,找出要附加共用流程的流程掛鉤。
    流程掛鉤位置 說明
    前置 Proxy 流程掛鉤 在 Proxy 端點執行前
    預先指定流程掛鉤 在目標端點執行前
    目標後流程掛鉤 目標回應執行後
    代理後流程鉤子 在 Proxy 端點之後,並在回應傳送至用戶端之前
  3. 將滑鼠游標移至清單中的流程掛鉤,即可顯示動作欄。
  4. 按一下「」。
  5. 在「共用流程」對話方塊中,選取「共用流程」下拉式選單中要附加的共用流程。
  6. 按一下「確定」。
  7. 視需要將共用流程附加至其他流程掛鉤。