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

本頁適用於 ApigeeApigee Hybrid

查看 Apigee Edge 說明文件。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  • 後置 Proxy 流程掛鉤:適用於需要在 Proxy 端點之後,且在回應傳送至用戶端之前執行的邏輯。

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

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

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

Cloud 控制台中的 Apigee

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

  1. 在瀏覽器中開啟 Cloud 控制台中的 Apigee UI
  2. 選取含有共用流程的機構。請參閱切換機構

    共用流程可供任何 API Proxy 和部署至這個機構環境的共用流程使用。這個應用程式不會提供給機構外部的使用者。

  3. 在左側導覽窗格中,依序按一下「管理」>「環境」
  4. 從可用環境清單中選取要編輯的環境。
  5. 按一下「環境詳細資料」頁面上的「流程掛鉤」分頁標籤。

    畫面上會顯示「Flow hooks」檢視畫面。

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

傳統版 Apigee

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

  1. 登入 Apigee UI
  2. 選取含有共用流程的機構。請參閱切換機構

    共用流程可供任何 API Proxy 和部署至這個機構環境的共用流程使用。這個應用程式不會提供給機構外部的使用者。

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

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

    流程掛鉤頁面,顯示 Proxy 前、目標前、Proxy 後和目標後共用流程

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