API-Proxy-Cookbook-Muster

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

In diesem Thema werden einige der API-Proxy-Entwicklungsmuster erläutert, die in den Cookbook-Beispielen zu Apigee Edge gezeigt wurden. Wenn wir weitere Kochbuchbeispiele hinzufügen, möchten wir diesem Thema weitere Muster hinzufügen.

JavaScript-HTTP-Clientmuster

Das JavaScript-HTTP-Clientmuster ist eines von mehreren Mustern, die Sie zum Erstellen von serverseitigen Mashups mit Apigee Edge verwenden können. Mit dem JavaScript-Objektmodell von Apigee können Sie JavaScript-Code direkt in einen API-Proxy-Ablauf einbinden. Mit dem Objekt httpClient des Objektmodells können Sie Back-End-Dienste aufrufen und Ergebnisse mithilfe von JavaScript abrufen.

Muster für die Richtlinienzusammensetzung

Die Richtlinienzusammensetzung ist ein Apigee API-Proxy-Muster, mit dem Sie Ergebnisse aus mehreren Back-End-Zielen mithilfe von Richtlinien zu einer einzigen Antwort kombinieren können. Tatsächlich können Sie durch die Richtlinienzusammensetzung Mashups mithilfe von Richtlinien erstellen.

Das Herzstück des Musters der Richtlinienzusammensetzung ist die Richtlinie ServiceCallout. Die ServiceCallout-Richtlinie fungiert als HTTP-Client für die Back-End-API oder den Back-End-Dienst. Damit ein ServiceCallout jedoch voll funktionsfähig ist, sind andere Richtlinien erforderlich, um sinnvolle Interaktionen 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 parsen.

Im Beispiel zur Richtlinienzusammensetzung werden drei Richtlinien verwendet: AssignMessage, ServiceCallout und ExtractVariables. Diese Richtlinien umfassen die request-Nachrichten, die Sie an das Back-End senden möchten, den Client, der die Nachricht an das Back-End weiterleitet, und einen Nachrichtenparser, der die Antwort von jeder API parst und Variablen für die Antwortdaten zuweist. Nach allen Aufrufen werden die gesammelten 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 von derAssignMessage-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 generierte Nachricht parst. Die Richtlinie legt dann Variablen fest, die die Werte enthalten, die aus der ServiceCallout-Antwort geparst wurden.

Ein vollständiges Beispiel zur Veranschaulichung des Musters der Richtlinienzusammensetzung finden Sie unter Richtlinienzusammensetzung verwenden.