Beispiel-API-Proxys verwenden

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

Voraussetzungen

Sie benötigen ein Konto auf http://enterprise.apigee.com. Sie können sich unter http://accounts.apigee.com/accounts/sign_up für ein Testkonto registrieren.

Wenn Sie Beispiele verwenden möchten, benötigen Sie außerdem Folgendes:

Tool Beschreibung
Git Die Beispiele befinden sich auf GitHub. Wenn Sie Git nicht installiert haben, lesen Sie die Anleitung zur Git-Einrichtung auf GitHub. Wenn Sie Git nicht installieren möchten, können Sie die Dateien durchsuchen und eine ZIP-Datei von https://github.com/apigee/api-platform-samples herunterladen.
Python

Zum Ausführen des Apigee-Bereitstellungstools ist Python erforderlich. Python ist in den meisten Linux-Umgebungen, auf einem Mac mit installiertem XCode, auf einem Windows-Computer mit installiertem Cygwin und an vielen anderen Orten vorhanden.

Sie erhalten Python auf der Python-Downloadseite.

curl Die Beispiel-Einrichtungsskripts verwenden ebenfalls curl. Prüfen Sie, ob curl installiert und in Ihrem Pfad verfügbar ist. Prüfen Sie mit dem Befehl which curl, ob die API auf Ihrem System verfügbar ist.
dos2unix Wenn Sie Cygwin unter Windows ausführen, benötigen Sie möglicherweise auch das Dienstprogramm dos2unix. Mit dem Cygwin-Installationsprogramm können Sie das Dienstprogramm installieren.

Beispiele herunterladen

Verwenden Sie git clone, wie im folgenden Beispiel gezeigt, um die Beispieldateien abzurufen:

git clone https://github.com/apigee/api-platform-samples.git

Beispiel-API-Proxys importieren und bereitstellen

Importieren Sie die Beispiele über die Befehlszeile und stellen Sie sie bereit:

  1. Nachdem Sie die Beispiele heruntergeladen haben, wechseln Sie wie im folgenden Beispiel zum Verzeichnis /setup:
    cd setup
  2. Suchen Sie im Verzeichnis /setup nach der Datei setenv.sh.
  3. Bearbeiten Sie diese Datei, um Ihre Organisation, die mit Ihrem Nutzernamen verknüpfte E-Mail-Adresse und die Umgebung (Produktion oder Test) festzulegen, in der Sie die API-Proxys bereitstellen möchten.
  4. Nachdem Sie setenv.sh bearbeitet haben, führen Sie Folgendes aus:
    sh deploy_all.sh

    Dieses Skript stellt alle API-Proxy-Beispiele in Ihrer Organisation bereit. Der Vorgang dauert 3–4 Minuten. Folgen Sie den Aufforderungen, um API-Produkte, Entwickler und Anwendungen bereitzustellen, die für OAuth verwendet werden.

  5. Wechseln Sie nach Abschluss des Bereitstellungsskripts zum Verzeichnis „sample-proxies“. Im Verzeichnis sample-proxies finden Sie ein Verzeichnis pro Beispiel-Proxy. In jedem Verzeichnis befinden sich eine README.md-Datei mit Informationen zum Ausführen des Beispiels und zwei Skripts, die Ihnen helfen, kleine Änderungen an den Beispielen vorzunehmen, das Beispiel bereitzustellen und dann aufzurufen, um zu sehen, welche Auswirkung die Änderung hatte:
    • invoke.sh: Führen Sie dieses Skript aus, um die bereitgestellte Version des API-Proxys aufzurufen.
    • deploy.sh: Führen Sie dieses Skript aus, um den API-Proxy bereitzustellen, nachdem Sie Änderungen vorgenommen haben.

Rufen Sie die Beispiel-API-Proxys auf

Jedem Beispiel-Proxy ist ein Shell-Skript zugeordnet, mit dem der API-Proxy nach der Bereitstellung aufgerufen werden kann.

Führen Sie im Verzeichnis /sample-proxies/proxy_name folgenden Befehl aus:

sh invoke.sh

Dadurch wird der Proxy aufgerufen, der in der Testumgebung Ihrer Organisation ausgeführt wird.

Fehlerbehebung

Informationen zur Fehlerbehebung finden Sie hier:

Beispiel-API-Proxys ändern und wiederverwenden

Beispiel-Proxys werden normalerweise zum Ändern, Bereitstellen und Aufrufen verwendet. So können Sie kleine Änderungen vornehmen und dann sehen, wie sie sich auf die Antwortnachricht auswirken.

Wenn Sie einen API-Beispiel-Proxy so ändern möchten, dass er auf einen anderen Back-End-Dienst verweist, bearbeiten Sie die XML-Konfigurationsdatei am folgenden Speicherort:

/apiproxy/targets/target_name.xml

Um beispielsweise das API-Schlüsselbeispiel auf Ihren eigenen Back-End-Dienst zu verweisen, suchen Sie diese Datei:

/apikey/apiproxy/targets/default.xml

Wenn die Standardkonfiguration auf http://mocktarget.apigee.net verweist, z. B.:

<TargetEndpoint name="default">
  <HTTPTargetConnection>
    <!-- This is where we define the target. For this sample we just use a simple URL. -->
    <URL>http://mocktarget.apigee.net</URL>
  </HTTPTargetConnection>
</TargetEndpoint>

und Ihr Back-End-Dienst unter http://api.myproject.com/ verfügbar ist, ändern Sie die Konfiguration so:

<TargetEndpoint name="default">
  <HTTPTargetConnection>
    <!-- This is where we define the target. For this sample we just use a simple URL. -->
    <URL>http://api.myproject.com/</URL>
  </HTTPTargetConnection>
</TargetEndpoint>

Nachdem Sie Ihre Änderungen gespeichert haben, stellen Sie den API-Proxy bereit, wie im folgenden Beispiel gezeigt:

sh deploy.sh

Die anderen API-Proxys können auf die gleiche Weise geändert werden, um die API-Proxy-Funktionalität für Ihre vorhandenen Zieldienste zu verwenden. In einigen Fällen hängt das API-Proxy-Verhalten jedoch von bestimmten Nachrichtenformaten ab, sodass die Proxys möglicherweise zusätzliche Konfigurationsänderungen erfordern.