Freigegebenen Ablauf mithilfe eines Ablauf-Hook anhängen

Sie sehen die Dokumentation zu Apigee Edge.
Zur Apigee X-Dokumentation weitere Informationen

Sie können freigegebene Abläufe für die Vorverarbeitung von Antworten oder Antworten auf eine Reihe von APIs anwenden. Mit einem Ablauf-Hook hängen Sie einen freigegebenen Ablauf an, sodass dieser für alle API-Proxys, die in einer bestimmten Umgebung bereitgestellt werden, zentral ausgeführt wird. Dadurch erhalten Sie eine separate implementierte und bereitgestellte Abfolge von Logik, die nicht Teil des Implementierungscodes eines Proxys ist.

Da der Code an einen Ablauf-Hook außerhalb des Kontexts der API-Proxy-Kernlogik gebunden ist, unterscheidet sich ein Teil des Verhaltens von API-Proxys. Beachten Sie Folgendes:

• Sie müssen die Berechtigung haben, einen freigegebenen Ablauf an einen Ablauf-Hook anzuhängen. Sie müssen ein Organisationsadministrator sein.
• Sie können an jeden Ablauf-Hook nur einen freigegebenen Ablauf anhängen.
• Sie können denselben freigegebenen Ablauf an mehrere Ablauf-Hooks anhängen.
• Wenn ein freigegebener Ablauf, der an einen Ablauf-Hook angehängt ist, einen Fehler auslöst oder während der Ausführung des freigegebenen Ablaufs Fehler auftreten, wird die Nachricht abgelehnt und der Fehler an den Aufrufer zurückgesendet.
• Wird eine Nachricht während der Ausführung eines Ablauf-Hooks abgelehnt, werden Details im Kontext des aufgerufenen Proxys in Analyse protokolliert. Der freigegebene Ablauf kann auch einen Fehler mit einem benutzerdefinierten Code und einer Fehlermeldung auslösen.

Im folgenden Video wird gezeigt, wie Sie einen freigegebenen Ablauf mit einem Ablauf-Hook verbinden und ihn dann in der klassischen Edge-Benutzeroberfläche verfolgen.

Im folgenden Video wird gezeigt, wie Sie einen freigegebenen Ablauf mit einem Ablauf-Hook verbinden und dann in der Benutzeroberfläche der neuen Edge-Oberfläche verfolgen.

Ein freigegebener Datenfluss, der über einen Ablauf-Hook an einen Proxy angehängt ist, eignet sich gut für die Logik, die allgemeine Richtlinienanforderungen erzwingt. Angenommen, ein Team verwaltet einen Satz von Sicherheitsanforderungen für mehrere Teams, die verschiedene Geschäftsbereiche (LOBs) repräsentieren. Jedes LOB-Team kann APIs gemäß seinen eigenen Anforderungen entwickeln, ohne die allgemeinen Sicherheitsanforderungen berücksichtigen zu müssen. Das Sicherheitsteam kann diese Sicherheitsanforderungen in einem gemeinsam genutzten Ablauf implementieren und dann den Ablauf mithilfe eines Ablauf-Hooks an die Apigee Edge-Umgebung anhängen. Da der freigegebene Ablauf nicht Teil des Proxy-Codes ist, kann das Sicherheitsteam ihn nach Bedarf anpassen, ohne den LOB-Code zu beeinträchtigen.

Freigegebene Abläufe, die über Ablauf-Hooks angehängt sind, werden für alle API-Proxys, die in der Umgebung des Proxy-Hooks bereitgestellt sind, an dieser Position ausgeführt. Aus diesem Grund ist die Möglichkeit zur Verwendung von Ablauf-Hooks nur für Administratoren einer Apigee Edge-Organisation verfügbar.

Weitere Informationen zu freigegebenen Abläufen finden Sie unter Wiederverwendbare freigegebene Abläufe.

Sie können einen Ablauf mithilfe der Apigee Edge-Verwaltungskonsole an einen Ablauf-Hook anhängen. An jedem der folgenden Orte können Sie maximal einen freigegebenen Ablauf an einen Ablauf-Hook anhängen:

• Pre-Proxy Flow Hook für Logik, die vor der Ausführung eines Proxy-Endpunkts erzwungen werden muss.

  Sie könnten beispielsweise eine Logik zur Erzwingung der Sicherheit für alle APIs in einer Umgebung haben.

• Pre-Target Flow Hook für Logik, die BEVOR ein Ziel aufgerufen werden muss.

  Sie können beispielsweise das Logging implementieren, bevor die Anfrage das Back-End erreicht. Sie können die Vermittlung auch erzwingen, indem Sie bestimmte Felder aus der Anfrage entfernen.

• Post-Target Flow Hook für Logik, die NACH der Ausführung der Zielantwort erzwungen werden muss.

  Dies wird direkt nach der Rückgabe der Antwort vom Back-End erzwungen. Sie können damit die Backend-Antwort protokollieren oder eine Mediation ausführen, indem Sie vertrauliche Felder aus der Backend-Antwort entfernen.

• Post-Proxy-Flow-Hook für Logik, die NACH dem Proxy-Endpunkt und direkt vor dem Senden der Antwort an den Client erzwungen werden muss.

  Dies kann eine Erzwingungslogik für CORS, die Antwort protokollieren oder Mashups oder Formatierungen machen.

Freigegebenen Ablauf zu einem Ablauf-Hook anhängen

Sie müssen Administrator in der Organisation sein, die den freigegebenen Ablauf enthält, um einen freigegebenen Ablauf an einen Ablauf-Hook anzuhängen.

1. Rufen Sie wie unten beschrieben die Seite "Flow Hooks" auf.

   Edge

   So greifen Sie über die Edge-Benutzeroberfläche auf die Seite "Flow Hooks" (Ablauf-Hooks) zu:

   1. Melden Sie sich unter apigee.com/edge an.
   2. Wählen Sie die Organisation aus, die den freigegebenen Ablauf enthält. Weitere Informationen finden Sie unter Zwischen Organisationen wechseln.

      Der freigegebene Ablauf ist für alle API-Proxys und freigegebene Abläufe verfügbar, die in einer Umgebung aus dieser Organisation bereitgestellt werden. Sie ist von außerhalb dieser Organisation nicht verfügbar.

   3. Wählen Sie in der linken Navigationsleiste Admin > Umgebungen > Ablauf-Hooks aus.

   Classic Edge (Private Cloud)

   So greifen Sie über die Classic Edge-Benutzeroberfläche auf die Seite "Flow Hooks" (Ablaufhaken) zu:

   1. Melden Sie sich bei http://ms-ip:9000 an, wobei ms-ip die IP-Adresse oder der DNS-Name des Knotens des Verwaltungsservers ist.
   2. Wählen Sie die Organisation aus, die den freigegebenen Ablauf enthält. Weitere Informationen finden Sie unter Zwischen Organisationen wechseln.

      Der freigegebene Ablauf ist für alle API-Proxys und freigegebene Abläufe verfügbar, die in einer Umgebung aus dieser Organisation bereitgestellt werden. Sie ist von außerhalb dieser Organisation nicht verfügbar.

   3. Wählen Sie in der oberen Navigationsleiste APIs > Umgebungskonfiguration > Flow-Hooks aus.
2. Identifizieren Sie in der Liste der Ablauf-Hooks den Ablauf-Hook, an den Sie den freigegebenen Ablauf anhängen möchten, je nachdem, wo der freigegebene Ablauf ausgeführt werden soll.

   Hook-Speicherort	Beschreibung
   Pre-Proxy-Ablauf-Hook	VOR der Ausführung eines Proxy-Endpunkts
   Vor-Ziel-Ablauf-Hook	BEVOR ein Zielendpunkt ausgeführt wird
   Post-Ziel-Ablauf-Hook	NACH der Ausführung der Zielantwort
   Post-Proxy-Ablauf-Hook	NACH dem Proxy-Endpunkt und direkt vor dem Senden der Antwort an den Client

3. Positionieren Sie den Cursor über dem Ablauf-Hook in der Liste, um die Aktionsspalte anzuzeigen.
4. Klicken Sie auf .
5. Wählen Sie im Dialogfeld „Shared Flow“ im Drop-down-Menü Shared Flow den freigegebenen Ablauf aus, den Sie anhängen möchten.
6. Klicken Sie auf OK.
7. Hängen Sie nach Bedarf gemeinsame Abläufe an andere Ablauf-Hooks an.