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

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

您可以讓共用流程執行一組 API 的樣板預先處理或回應後續處理作業。只要使用資料流掛鉤，即可附加共用流程，以便它在已部署至特定環境的所有 API Proxy 的相同位置執行。如此一來，您就能另外實作和部署的邏輯序列，該序列不屬於 Proxy 的實作程式碼。

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

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

以下影片說明如何在傳統版 Edge UI 中將共用流程連線至流程掛鉤，然後進行追蹤。

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

透過資料流掛鉤連結至 Proxy 的共用流程，是針對強制執行廣泛政策規定的邏輯的最佳位置。舉例來說，假設您有一個團隊負責管理多個團隊，且負責代表不同業務線 (LOB) 的一組安全性要求。各個 LOB 團隊可根據自己的需求開發 API，無需考量較廣泛的安全性需求。資安團隊可以在共用流程中實施這些安全性規定，然後使用流程掛鉤將流程附加至 Apigee Edge 環境。由於共用流程不屬於 Proxy 程式碼，因此安全團隊可以視需要修改，而不會幹擾 LOB 程式碼。

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

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

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

  • 預先 Proxy 流程掛鉤適用於在執行 Proxy 端點「之前」強制執行的邏輯。

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

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

    例如，您可以在要求到達後端前實作記錄功能。此外，您也可以移除請求中的特定欄位，強制執行中介服務。

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

    這個將會在回應從後端傳回後立即強制執行。您可以用來記錄後端回應，也可以從後端回應中移除敏感欄位，藉此執行部分中介服務。

  • 後 Proxy 流程掛鉤適用於需要在 Proxy 端點「之後」強制執行的邏輯，以及在將回應傳送至用戶端前立即強制執行的邏輯。

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

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

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

  1. 按照下文說明存取「Flow Hooks」頁面。

    Edge

    如何使用 Edge UI 存取「Flow Hooks」頁面：

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

      共用流程將適用於所有 API Proxy，以及部署至此機構中特定環境的共用流程。機構外部人員將無法存取其中內容。

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

    傳統邊緣 (Private Cloud)

    如何使用傳統版 Edge UI 存取「流程掛鉤」頁面：

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

      共用流程將適用於所有 API Proxy，以及部署至此機構中特定環境的共用流程。機構外部人員將無法存取其中內容。

    3. 在頂端的導覽列中，依序選取「API」>「環境設定」>「流程掛鉤」。
  2. 在流程掛鉤清單中，根據您要執行共用流程的位置，找出要附加共用流程的流程掛鉤。
    流程掛勾位置 說明
    預先 Proxy 流程掛勾 執行 Proxy 端點「之前」
    預先目標流程掛鉤 目標端點執行前
    鎖定目標的流程掛勾 目標回應執行後
    後 Proxy 流程掛勾 在 Proxy 端點之後，在將回應傳送至用戶端前的緊接著開始
  3. 將遊標移到清單中的流程掛鉤上，即可顯示動作資料欄。
  4. 按一下「」。
  5. 在「共用流程」對話方塊中，在「共用流程」下拉式選單中，選取要附加的共用流程。
  6. 點選「OK」。
  7. 視需要將共用的流程附加至其他流程掛鉤。