API-Proxy-Cookbook-Muster

Sie sehen sich die Dokumentation zu Apigee Edge an.
Sehen Sie sich die Apigee X-Dokumentation an.
info

In diesem Thema werden einige der API-Proxy-Entwicklungsmuster erläutert, die in den Apigee Edge-Rezeptbeispielen gezeigt werden. Wir planen, diesem Thema weitere Muster hinzuzufügen, sobald wir weitere Kochbuchbeispiele hinzufügen.

Das JavaScript-HTTP-Client-Muster

Das JavaScript-HTTP-Client-Muster ist eines von mehreren Mustern, mit denen Sie serverseitige Mashups mit Apigee Edge erstellen können. Mit dem JavaScript-Objektmodell von Apigee können Sie JavaScript-Code direkt in einen API-Proxy-Ablauf einbinden. Mit dem httpClient-Objekt des Objektmodells können Sie Back-End-Dienste aufrufen und Ergebnisse mit JavaScript abrufen.

Das Muster für die Richtlinienzusammensetzung

Die Richtlinienzusammensetzung ist ein Apigee API-Proxy-Muster, mit dem Sie mithilfe von Richtlinien Ergebnisse aus mehreren Back-End-Zielen in einer einzigen Antwort kombinieren können. Mit der Richtlinienzusammensetzung können Sie also Mashups mithilfe von Richtlinien erstellen.

Im Mittelpunkt des Musters für die Richtlinienzusammensetzung steht die ServiceCallout. Die ServiceCallout-Richtlinie fungiert als HTTP-Client für die Backend-API oder den Backend-Dienst. Für eine vollständige Funktionsweise ist jedoch eine ServiceCallout-Richtlinie erforderlich, um eine sinnvolle Interaktion mit einer Remote-API oder einem Remote-Dienst zu ermöglichen. Andere Richtlinien werden verwendet, um die vom ServiceCallout gesendete Anfragenachricht zu generieren und den Inhalt der Antwortnachricht von der Remote-API oder dem Remote-Dienst zu analysieren.

Im Beispiel für ein Cookbook zur Richtlinienzusammensetzung werden drei Richtlinien verwendet: AssignMessage, ServiceCallout und ExtractVariables. Diese Richtlinien umfassen die Anfragenachrichten, die Sie an das Backend senden möchten, den Client, der die Nachricht an das Backend weiterleitet, und einen Nachrichtenparser, der die Antwort von jeder API analysiert und Variablen für die Antwortdaten zuweist. Nachdem alle Aufrufe erfolgt sind, werden die erfassten Variablen kombiniert und in einem einzigen JSON-Objekt zurückgegeben.

Hier eine kurze Zusammenfassung dieser drei Richtlinien:

  • AssignMessage: Erstellt eine Anfragenachricht, füllt HTTP-Header und Abfrageparameter aus und legt das HTTP-Verb fest.
  • ServiceCallout: Verweist auf eine Nachricht, die mit der AssignMessage-Richtlinie erstellt wurde, definiert eine Ziel-URL für den externen Aufruf und definiert einen Namen für das Antwortobjekt, das der Zieldienst zurückgibt.
  • ExtractVariables: Definiert in der Regel einen JSONPath- oder XPath-Ausdruck, der die von der vorherigen ServiceCallout-Richtlinie erzeugte Nachricht parst. Die Richtlinie legt dann Variablen mit den Werten fest, die aus der ServiceCallout-Antwort geparst wurden.

Unter Richtlinienzusammensetzung verwenden finden Sie ein vollständiges Beispiel für das Richtlinienzusammensetzungsmuster.