API-Proxy-Cookbook-Muster

Sie lesen gerade die Dokumentation zu Apigee Edge.
Zur Dokumentation zu Apigee X.
info

In diesem Thema werden einige der Entwicklungsmuster für API-Proxys behandelt, die in den Apigee Edge-Cookbook-Beispielen gezeigt werden. Wenn wir weitere Cookbook-Beispiele hinzufügen, werden wir diesem Thema weitere Muster hinzufügen.

Das JavaScript-HTTP-Clientmuster

Das JavaScript-HTTP-Clientmuster 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 mit JavaScript Aufrufe an Back-End-Dienste senden und Ergebnisse abrufen.

Das Muster der Richtlinienzusammensetzung

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

Das Herzstück des Musters der Richtlinienzusammensetzung ist die ServiceCallout-Richtlinie. Die ServiceCallout-Richtlinie fungiert als HTTP-Client für die Back-End-API oder den Back-End-Dienst. Damit sie jedoch vollständig funktioniert, ist eine ServiceCallout-Richtlinie auf andere Richtlinien angewiesen, um eine sinnvolle Interaktion mit einer Remote-API oder einem Remote-Dienst zu ermöglichen. Andere Richtlinien werden verwendet, um die Anfragenachricht zu generieren, die von der ServiceCallout-Richtlinie gesendet wird, und um den Inhalt in der Antwortnachricht von der Remote-API oder dem Remote-Dienst zu parsen.

Im Cookbook-Beispiel zur Richtlinienzusammensetzung werden drei Richtlinien verwendet: AssignMessage, ServiceCallout, und ExtractVariables. Diese Richtlinien kapseln die Anfragenachricht(en) , 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. Nachdem alle Aufrufe ausgeführt wurden, werden die gesammelten Variablen kombiniert und in einem einzelnen 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 Antwort Objekt, 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, das das Muster der Richtlinienzusammensetzung veranschaulicht.