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

本頁內容適用於 ApigeeApigee Hybrid

查看 Apigee Edge 說明文件。

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

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

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

以下影片說明如何在 Apigee UI 中,將共用流程連結至流程掛鉤,然後追蹤該流程。

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

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

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

您可以使用 Apigee UI 或 Flowhooks API,將共用流程附加至流程掛鉤。您最多可以在下列位置,將一個共用流程附加至流程掛鉤:

  • Proxy 前置流程掛鉤:用於在 Proxy 端點執行前強制執行的邏輯。

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

  • 目標前流程掛鉤:用於在目標端點執行前強制執行的邏輯。

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

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

    後端傳回回應後,系統會立即強制執行這項設定。您可以使用這個函式記錄後端回應,或從後端回應中移除敏感欄位,執行部分中介服務。

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

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

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

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

透過 Cloud 控制台使用 Apigee

如要將共用流程附加至流程掛鉤,請按照下列步驟操作:

  1. 在 Google Cloud 控制台,前往「管理」>「環境」頁面。

    前往「環境」頁面

  2. 選取共用流程所屬的機構。請參閱「切換機構」。

    這個機構部署至環境的任何 API Proxy 和共用流程,都能使用共用流程。這個應用程式不會對機構外部使用者開放。

  3. 從可用環境清單中選取要編輯的環境。
  4. 在「環境詳細資料」頁面中,按一下「流程掛鉤」分頁標籤。

    系統會顯示「流程掛鉤」檢視畫面。

  5. 在流程掛鉤清單中,找出要附加共用流程的流程掛鉤。 選擇的流程掛鉤取決於您要執行共用流程的位置。
    流程掛鉤位置 說明
    前置 Proxy 在 Proxy 端點執行「之前」執行
    預先指定目標 在目標端點執行之前執行
    後目標 在目標回應執行執行
    後端 Proxy 在 Proxy 端點之後執行,並在將回應傳送給用戶端之前執行
  6. 在所選流程掛鉤的清單方塊中,選取要附加的共用流程。
  7. 視需要將共用流程附加至其他流程掛鉤。
  8. 按一下「儲存」,將所選共用流程附加至流程掛鉤。

傳統版 Apigee

如要將共用流程附加至流程掛鉤,請按照下列步驟操作:

  1. 登入 Apigee UI
  2. 選取共用流程所屬的機構。請參閱「切換機構」。

    這個機構部署至環境的任何 API Proxy 和共用流程,都能使用共用流程。這個應用程式不會對機構外部使用者開放。

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

    「流程掛鉤」檢視畫面會顯示:

    「流程掛鉤」頁面,顯示 Pre-proxy、Pre-target、Post-proxy 和 Post-target 共用流程

  4. 從環境下拉式清單中,選取要修改的環境。
  5. 在流程掛鉤清單中,找出要附加共用流程的流程掛鉤。 選擇的流程掛鉤取決於您要執行共用流程的位置。
    流程掛鉤位置 說明
    前置 Proxy 在 Proxy 端點執行「之前」執行
    預先指定目標 在目標端點執行之前執行
    後端 Proxy 在 Proxy 端點之後執行,並在將回應傳送給用戶端之前執行
    後目標 在目標回應執行執行
  6. 將游標懸停在清單中的流程掛鉤上,即可顯示動作欄。
  7. 按一下「Edit」(編輯)
  8. 在「共用流程」對話方塊中,從「共用流程」選單選取要附加的共用流程。
  9. 按一下 [確定]
  10. 視需要將共用流程附加至其他流程掛鉤。