Entwicklertools

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

Als Dienstanbieter entwickeln Sie APIs für die Nutzung durch Client-Apps. Zum Erstellen, Konfigurieren und Verwalten von API-Proxys und API-Produkten können Sie die Benutzeroberfläche verwenden oder HTTP-Anfragen an die APIs senden, um auf RESTful-Dienste zuzugreifen, wie in den folgenden Abschnitten beschrieben.

Verwenden Sie die Edge-Benutzeroberfläche

Die Apigee Edge-UI ist ein browserbasiertes Tool, mit dem Sie API-Proxys und API-Produkte erstellen, konfigurieren und verwalten können. Einige Aufgaben können ebenfalls nur mit der API ausgeführt werden.

In der folgenden Tabelle wird beschrieben, wie Sie auf die Edge-Benutzeroberfläche zugreifen:

Produkt Name der Benutzeroberfläche Zugriffs-URL
Edge Edge-Benutzeroberfläche

Verwenden Sie die folgende URL, um auf die Edge-Benutzeroberfläche zuzugreifen:

https://apigee.com/edge

Eine Anleitung zur Verwendung der Edge-Benutzeroberfläche finden Sie unter Ersten API-Proxy erstellen.

Edge für Private Cloud Klassische Edge-Benutzeroberfläche

Verwenden Sie die folgende URL, um auf die Edge-Benutzeroberfläche für Edge für Private Cloud zuzugreifen:

http://ms-ip:9000

Dabei ist ms-ip die IP-Adresse oder der DNS-Name des Verwaltungsserverknotens.

Mit der Edge-Benutzeroberfläche können Sie:

  • Erstellen Sie API-Proxys, indem Sie Code bearbeiten und Anfrageflüsse durch Ihre Proxys verfolgen.
  • Erstellen Sie API-Produkte, die Proxys für die Offenlegung für Clientanfragen bündeln.
  • Entwickler und Entwickler-Apps verwalten
  • Test- und Produktionsumgebungen konfigurieren
  • JavaScript- und Node.js-Anwendungen implementieren

Die folgende Abbildung zeigt den API-Proxy-Editor in der Benutzeroberfläche, mit dem Sie einen API-Proxy erstellen und konfigurieren können:

Zeigt den im API-Proxy-Editor in der Edge-Benutzeroberfläche ausgewählten Tab „Develop“ an.

Edge-API verwenden

Sie können die Edge API verwenden, um Ihre API-Ressourcen zu verwalten. Die APIs bieten auch Zugriff auf untergeordnete Funktionen, die nicht über die UI verfügbar sind.

Die API-Endpunkte verwenden häufig Daten, die Konfigurationsinformationen enthalten, und verlangen, dass Sie für den Zugriff Authentifizierungsinformationen wie Nutzername und Passwort weitergeben. Gemäß den RESTful-Prinzipien können Sie die HTTP-Methoden GET, POST, PUT und DELETE für jede der API-Ressourcen aufrufen.

Eine vollständige Liste der Apigee Edge-APIs finden Sie in der Apigee Edge API-Referenz.

Informationen zum Basispfad der Edge API

Der Pfad, den Sie in API-Anfragen verwenden, verkettet Folgendes:

  • Ein Basispfad, der den Namen Ihrer Organisation enthält. Beispiel: https://api.enterprise.apigee.com/v1/organizations/org_name.
  • Einen Endpunkt, der auf die Edge-Ressource verweist, auf die Sie zugreifen.

Wenn Ihr Organisationsname beispielsweise apibuilders lautet, wird für jeden Aufruf der API der folgende Basispfad verwendet:

https://api.enterprise.apigee.com/v1/organizations/apibuilders

Um eine Liste der API-Proxys in Ihrer Organisation abzurufen, rufen Sie GET auf:

https://api.enterprise.apigee.com/v1/organizations/apibuilders/apis

Viele Ressourcen werden nach Umgebung begrenzt. Standardmäßig werden zwei Umgebungen bereitgestellt: Test und Prod. Caches werden beispielsweise nach Umgebung kategorisiert. Ein freigegebener Cache namens „mycache“ ist standardmäßig in jeder Umgebung enthalten.

Sie können Caches auflisten, indem Sie GET für die Cache-Ressource wie folgt aufrufen:

https://api.enterprise.apigee.com/v1/organizations/apibuilders/environments/test/caches
https://api.enterprise.apigee.com/v1/organizations/apibuilders/environments/prod/caches

Zugriff authentifizieren

Sie müssen sich beim API-Server authentifizieren, wenn Sie die APIs aufrufen. Dazu haben Sie folgende Möglichkeiten:

Darüber hinaus empfiehlt Apigee die Verwendung der 2-Faktor-Authentifizierung, wie unter 2-Faktor-Authentifizierung für Ihr Apigee-Konto aktivieren beschrieben.

Edge API-Limits

Jede Organisation ist auf die folgenden Edge API-Aufrufraten beschränkt:

  • 10.000 Anrufe pro Minute für Organisationen mit kostenpflichtigen Tarifen
  • 600 Aufrufe pro Minute für Testorganisationen

Die HTTP-Statuscodes 401 und 403 werden nicht auf dieses Limit angerechnet. Bei allen Aufrufen, die diese Limits überschreiten, wird der Statuscode 429 Too Many Requests zurückgegeben.

Tipps für die Arbeit mit Edge APIs

In diesem Abschnitt werden einige Techniken beschrieben, die die Arbeit mit den Edge APIs erleichtern.

Anfrage-URLs kürzen

Wenn Sie Ihre Anfrage-URL für die Edge-APIs erstellen, können Sie die folgenden Abkürzungen verwenden:

  • /e = /environments
  • /o = /organizations
  • /r = /revisions

Abkürzungen müssen einheitlich verwendet werden. Kürzen Sie also, wie oben erwähnt und im folgenden Beispiel veranschaulicht, alle Elemente im Pfad oder gar keine. Die Verwendung vollständiger und abgekürzter Elemente im selben Pfad führt zu einem Fehler.

Beispiel:

THIS:
https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval/environments/prod/apis/helloworld/revisions/1/deployments
CAN BE MUCH SHORTER:
https://api.enterprise.apigee.com/v1/o/ahamilton-eval/e/prod/apis/helloworld/r/1/deployments

curl-Befehle ausführen

Verwenden Sie einen HTTP-Client, um Anfragen an die API zu senden. Viele Beispiele in der Dokumentation enthalten API-Beispielanfragen mit dem weitverbreiteten HTTP-Client curl. Wenn Sie curl installieren müssen, können Sie es unter http://curl.haxx.se herunterladen.

API-Aufrufe unterstützen die GZIP-Komprimierung für Antworten. Wenn Sie 'Accept-Encoding: gzip, deflate' in Ihren API-Aufrufen festlegen, wird jede Antwort, die größer als 1.024 Byte ist, im gzip-Format zurückgegeben.

XML- und JSON-Anfragen und -Antworten formatieren

Die Edge API gibt Daten standardmäßig im JSON-Format zurück. Bei vielen Anfragen können Sie die Antwort stattdessen im XML-Format zurücksenden lassen. Legen Sie dazu den Anfrageheader Accept auf application/xml fest, wie im folgenden Beispiel gezeigt:

curl -H "Authorization: Bearer `get_token`" \
  -H "Accept: application/xml" \
  https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval/apis/helloworld/revisions/1/policies/ \
  | xmllint --format -

Die Antwort sollte in etwa so aussehen:

<List>
  <Item>SOAP-Message-Validation-1</Item>
  <Item>Spike-Arrest-1</Item>
  <Item>XML-to-JSON-1</Item>
</List>

In diesem Beispiel wird prettyprint verwendet, um die Ergebnisse anzuzeigen. Dazu wird die Antwort über xmllint weitergeleitet.

Das acurl-Dienstprogramm unterstützt den Accept-Header nicht. Daher können Sie mit acurl nur Antworten im JSON-Format erhalten.

Wenn Sie prettyprint für eine JSON-Antwort verwenden möchten, können Sie die Python-Bibliothek json.tool verwenden:

curl https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval/apis/helloworld/revisions/1/policies/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer `get_token`" \
  | python -m json.tool

Im Folgenden finden Sie ein Beispiel für die Antwort:

[
  "SOAP-Message-Validation-1",
  "Spike-Arrest-1",
  "XML-to-JSON-1"
]

Für XML kannst du xmllint verwenden:

curl https://ahamilton-eval-test.apigee.net/getstarted -u email_address | xmllint --format -

Verwenden Sie beim POSTen oder PUTEN von Nutzlasten in XML den HTTP-Header Content-type:

acurl -H "Content-type:text/xml" -X POST -d \
'<XMLPayload>
 </XMLPayload> ' \
https://api.enterprise.apigee.com/v1/organizations/apifactory/apis -u email_address

Bereitstellungsumgebungen

Jede Organisation, die Apigee Edge verwendet, hat standardmäßig mindestens zwei Umgebungen zum Entwickeln, Testen und Bereitstellen von APIs: „Test“ und „Prod“. Verwenden Sie die „Testumgebung“ zum Entwickeln und Testen Ihrer APIs, bevor Sie sie öffentlich verfügbar machen. Nur Ihre internen Entwickler können auf APIs zugreifen, die in der Testumgebung bereitgestellt werden. Stellen Sie Ihre APIs in der Produktumgebung bereit, um sie für App-Entwickler öffentlich verfügbar zu machen.

Fehlerbehebung und Tests

Apigee bietet ein Trace-Tool, mit dem Sie Fehler in End-to-End-Anfrage- und Antwortabläufen beheben können. In den Trace-Ergebnissen werden Anfrage- und Antwortheader und -Nutzlasten, die Richtlinienausführung, Variablenwerte und alle Fehler angezeigt, die während des Ablaufs aufgetreten sind.

Wichtige Datenpunkte zur Verwendung bei der Fehlerbehebung:

  • Zeitstempel: Anhand von Zeitstempeln können Sie sehen, wie lange die Ausführung jedes einzelnen Schritts dauert. Durch den Vergleich von Zeitstempeln können Sie die Richtlinien isolieren, deren Ausführung am längsten dauert und die Ihre API-Aufrufe verlangsamen.
  • Basispfad: Durch Überprüfen des Basispfads können Sie dafür sorgen, dass eine Richtlinie die Nachricht an den richtigen Server weiterleitet.
  • Ergebnisse der Richtlinienausführung: Diese Ergebnisse geben an, ob die Nachricht wie erwartet geändert wird, z. B. ob die Nachricht von XML in JSON umgewandelt oder im Cache gespeichert wird.

Die folgende Abbildung zeigt Trace-Ergebnisse:

Zeigt den im API-Proxy-Editor in der Edge-Benutzeroberfläche ausgewählten Trace-Tab an.

Jede Trace-Sitzung wird in die folgenden Hauptschritte unterteilt:

  • Ursprünglich vom Client empfangene Anfrage: Zeigt das Verb und den URI-Pfad der Anfrage aus der Client-App, Header, Textdaten und Abfrageparameter an.
  • An Ihren Back-End-Dienst gesendete Anfrage: Zeigt die Anfragenachricht an, die vom API-Proxy an den Back-End-Dienst gesendet wurde.
  • Vom Back-End-Dienst zurückgegebene Antwort: Zeigt die vom Back-End-Dienst zurückgegebenen Antwortheader und Nutzlast an.
  • Endgültige Antwort an Client gesendet:Die Antwortnachricht, die an die anfragende Client-App zurückgegeben wird, sobald der Antwortfluss ausgeführt wurde.