Beispiel-API-Proxys verwenden

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

Vorbereitung

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

Für die Verwendung von Beispielen 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 von 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

Python ist erforderlich, um das Apigee-Bereitstellungstool auszuführen. 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.

Python finden Sie auf der Python-Downloadseite.
curl Die Beispiel-Einrichtungsskripts verwenden auch curl. Stellen Sie sicher, dass curl installiert und in Ihrem Pfad verfügbar ist (führen Sie den Befehl which curl aus, um zu sehen, ob es auf Ihrem System verfügbar ist).
dos2unix Wenn Sie Cygwin unter Windows ausführen, benötigen Sie möglicherweise auch das dos2unix Dienstprogramm. Mit dem Cygwin-Installationsprogramm können Sie das Dienstprogramm installieren.

Beispiele herunterladen

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

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

Beispiel-API Proxys importieren und bereitstellen

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

  1. Wechseln Sie nach dem Herunterladen der Beispiele zum Verzeichnis /setup, wie im folgenden Beispiel gezeigt: 
    cd setup
  2. Suchen Sie im Verzeichnis /setup die Datei setenv.sh.
  3. Bearbeiten Sie diese Datei, um Ihre Organisation, die mit Ihrem Nutzernamen verknüpfte E-Mail-Adresse und die Umgebung (prod oder test) festzulegen, in der Sie die API-Proxys bereitstellen möchten.
  4. Führen Sie nach dem Bearbeiten von setenv.sh Folgendes aus: 
    sh deploy_all.sh

    Mit diesem Skript werden alle API-Proxy-Beispiele in Ihrer Organisation bereitgestellt. Der Vorgang dauert 3 bis 4 Minuten. Folgen Sie der Anleitung, um API-Produkte, Entwickler und Apps 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. Jedes Verzeichnis enthält eine README.md-Datei mit Informationen zum Ausführen des Beispiels und zwei Skripts, die Ihnen helfen, kleine Änderungen an den Beispielen vorzunehmen, sie bereitzustellen und dann das Beispiel aufzurufen, um zu sehen, welche Auswirkungen Ihre Ä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 nach Änderungen bereitzustellen.

Beispiel-API-Proxys aufrufen

Jeder Beispiel-Proxy hat ein zugehöriges Shell-Skript, mit dem der API-Proxy nach der Bereitstellung aufgerufen werden kann.

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

sh invoke.sh

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

Fehlerbehebung

Informationen zur Fehlerbehebung finden Sie hier:

Beispiel-API-Proxys ändern und wiederverwenden

Die Beispiel-Proxys werden in der Regel geändert, bereitgestellt und aufgerufen. So können Sie kleine Änderungen vornehmen und dann sehen, welche Auswirkungen sie auf die Antwortnachricht haben.

Wenn Sie einen Beispiel-API-Proxy so ändern möchten, dass er auf einen anderen Backend-Dienst verweist, ändern Sie die XML-Konfigurationsdatei an folgendem Speicherort:

/apiproxy/targets/target_name.xml

Wenn Sie beispielsweise das API-Schlüsselbeispiel auf Ihren eigenen Backend-Dienst verweisen möchten, 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 Backend-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 die Änderungen gespeichert haben, stellen Sie den API-Proxy bereit, wie im folgenden Beispiel gezeigt:

sh deploy.sh

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