Wichtige Aspekte der API-Proxy-Entwicklung

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

Auf dieser Seite werden einige grundlegenden Merkmale von API-Proxys sowie Links zu weiteren Informationen aufgeführt.

APIs sind Einstiegspunkte, die es Anwendungen erlauben, die Funktionen anderer Anwendungen zu nutzen. API-Proxys werden implementiert, um APIs zu erstellen

Um in Apigee Edge API-Proxys zu implementieren konfigurieren Sie die API-Proxy-Logik als Abfolge von Schritten, die auf eine Anfrage vom Clientcode hin ausgeführt werden. Um ein API-Proxy für Clients verfügbar zu machen definieren Sie Endpunkte, die eine URL mit Ressourcenpfaden, ein HTTP-Verb, Anforderungen usw. enthalten.

Obwohl dies als API-Proxy bezeichnet wird, handelt es sich aus Sicht des Clientcodes um die API.

Mehr Informationen zu API-Proxys finden sich unter Informationen zu APIs und API-Proxys.

Die Reihenfolge der API-Proxylogik wird durch Abläufe arrangiert

In jeder Anwendung werden Daten über die Anwendung durch die Bedingungslogik übertragen. In Apigee Edge besteht der Verarbeitungspfad aus Abläufen. Ein Ablauf ist eine Abfolge von Phasen (oder „Schritten“), die den Verarbeitungspfad eines API-Proxys bilden. Mithilfe von Datenflüssen bietet Apigee Edge Ihnen Möglichkeiten, Logik und Verhalten an bestimmten Stellen anzuwenden, vom Client zur Back-End-Ressource und dann zurück zum Client.

Weitere Informationen zu Abläufen finden sich unter Ausführung eines Proxys mit Abläufen steuern.

Der Zugriff auf Statusdaten erfolgt über von API-Proxys erstellte Ablaufvariablen

Ein API-Proxy hat Zugriff auf Variablen, die den Ausführungsstatus darstellen. Sie können auf diese Variablen über die XML zugreifen, die Ihre API-Proxys und Richtlinien konfiguriert. Sie können auch auf die API zugreifen, wenn Sie einen API-Proxy mit einer Programmiersprache erweitern, z. B. Java, JavaScript oder Python.

Diese Variablen werden von Apigee Edge verwaltet. Einige sind standardmäßig vorhanden, da sie in der Regel den API-Proxys ähneln (z. B. weil sie Teil einer HTTP-Anfrage sind). Sie können auch eigene Variablen erstellen, um eine Logikanforderung zu erfüllen.

Weitere Informationen zu Variablen finden Sie unter Proxystatus mit Ablaufvariablen verwalten.

API-Proxys können bedingt ausgeführt werden

Wie bei den meisten Programmiersprachen kann Code auch im Fall von API-Proxys bedingt ausgeführt werden. Bedingungen basieren häufig auf dem API-Proxystatus, der über Ablaufvariablen verfügbar ist. Beispiel: Sie können eine Bedingung haben, die den User-Agent prüft und dann die Anfrage entsprechend verarbeitet.

Weitere Informationen zur bedingten Ausführung finden sich unter Ablaufvariablen und -bedingungen.

Meist wird Logik in API-Proxys durch Richtlinien implementiert

Die meiste Logik, die einem API-Proxy hinzugefügt wird, wird als Richtlinie übergeben. Eine Richtlinie ist eine Apigee Edge-Komponente, die Logik für einen Funktionsbereich, z. B. Sicherheit oder Traffic-Verwaltung, kapselt. Sie konfigurieren eine Richtlinie mit XML und legen so die Eigenschaften für die zugrunde liegende Logik fest. Richtlinien werden in einer Abfolge von "Schritten" innerhalb eines Ablaufs arrangiert, sodass der API-Proxy die Logik in der optimalen Reihenfolge für die Ziele Ihres Proxys ausführt.

Weitere Informationen zu Richtlinien finden sich unter Was sind Richtlinien?

Es können wiederverwendbare Funktionen genutzt werden

Wenn Ihr API-Proxy eine Logik enthält, die von mehreren Stellen im Code verwendet wird (z. B. von anderen API-Proxys), so können Sie diese Logik für Aufrufe von mehreren Orten aus bereitstellen. Beispiel: Sie können die Sicherheitslogik in einem freigegebenen Ablauf gruppieren, den andere API-Proxys aufrufen, wodurch die Duplizierung für API-Proxys reduziert wird.

Weitere Informationen zu freigegebenen Abläufen finden sich unter Wiederverwendbare freigegebene Abläufe. Weitere Informationen zur API-Proxy-Verkettung finden sich unter API-Proxys kombinieren.

Proxys können mit dem Trace-Tool debuggt werden

Apigee Edge enthält ein Trace-Tool, mit dem Sie beim Debuggen und Testen den Ausführungsablauf Ihres API-Proxys prüfen können. Das Tool stellt jeden API-Proxyschritt visuell dar, der für eine Anfrage ausgeführt wird. Wie bei einem Debugger können Sie bei jedem Schritt die Liste der Variablenwerte des API-Proxystatus aufrufen.

Weitere Informationen zur Fehlerbehebung mit Trace finden sich unter Trace-Tool verwenden.

API-Proxyfehler werden als Fehler behandelt

Durch die Konfiguration eines Fehler-Handlers können Sie den an einen API-Client zurückgegebenen Fehler anpassen. Mit Fehler-Handlern können Sie Fehlermeldungen steuern, unabhängig davon, ob der Fehler durch Ihren eigenen Code oder eine enthaltene Komponente (z. B. einer Richtlinie) bedingt wurde.

Weitere Informationen finden sich unter Fehlerbehandlung.