Was sind Erweiterungen?

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

Sie können Erweiterungen verwenden, um externe Ressourcen in Ihre API-Proxys zu integrieren. Sie können beispielsweise Google Cloud Platform-Dienste wie Google Cloud Storage einbinden. Ein API-Proxy verwendet die Erweiterung zur Laufzeit, um Anforderungen und Antworten mit der externen Ressource auszutauschen.

Runtime-Framework für Erweiterungen

Zur Laufzeit fungiert eine Erweiterung als Vermittler und verarbeitet Anfragen und Antworten zwischen einem API-Proxy und einer externen Ressource.

Im Folgenden erhalten Sie einen Überblick darüber, wie die Verarbeitung über eine Erweiterung während der Laufzeit funktioniert.

  1. Eine Clientanfrage erreicht einen API-Proxy und der Anfragefluss wird durch die Richtlinien des Proxys fortgesetzt.
  2. Der Anfragefluss erreicht im Proxy eine Extension Callout-Richtlinie, die so konfiguriert ist, dass Daten an eine in der Umgebung bereitgestellte Erweiterung übergeben werden. Die Daten enthalten Werte, die erforderlich sind, um eine Anfrage an die von der Erweiterung repräsentierte externe Ressource zu senden.
  3. Die Erweiterung sendet eine Anfrage an die externe Ressource und empfängt dann eine Antwort.
  4. Die Erweiterung übergibt ihre Antwort an die Extension Callout-Richtlinie zurück, in der sie vom Proxy-Code verarbeitet wird.
  5. Der Anfragefluss wird über den Proxy fortgesetzt, bis eine Antwort an den Client zurückgegeben wird.

Mit Erweiterungen arbeiten

Jede Erweiterung wird für eine bestimmte externe Ressource entwickelt und konfiguriert. Ein Apigee Edge-Administrator und ein API-Proxy-Entwickler führen die folgenden allgemeinen Schritte aus, um eine Erweiterung zu verwenden:

  • Ein Organisationsadministrator von Apigee Edge konfiguriert und stellt die Erweiterung bereit. Er konfiguriert es mit Werten, die genau auf die Anforderungen des Unternehmens abgestimmt sind. Mit dieser Konfiguration wird eine Erweiterungsinstanz erstellt, die für die Verwendung durch den API-Proxy-Entwickler fokussiert ist. Er könnte beispielsweise eine Erweiterung für den Zugriff auf einen bestimmten Bucket in Google Cloud Storage konfigurieren, einschließlich der erforderlichen Anmeldedaten zur Authentifizierung.
  • Ein API-Proxy-Entwickler verwendet eine konfigurierte Erweiterung in einem API-Proxy, indem er dem Proxy eine Extension Callout-Richtlinie hinzufügt. Die Konfiguration der Richtlinie legt Folgendes fest:
    • welche konfigurierte Erweiterung verwendet werden soll.
    • Die Erweiterungsaktionen (sie sind als Funktionsaufrufe an die Erweiterung zu verstehen), die aufgerufen werden sollen.
    • Die Aktionsparameter, die mit dem Aktionsaufruf übergeben werden sollen. Zur Laufzeit verwendet die Richtlinie die Erweiterung für den Zugriff auf die externe Ressource als Teil des Proxy-Ablaufs.

Dokumentation zu Erweiterungen

Unter den folgenden Themen finden Sie weitere Informationen zu Erweiterungen: