Beispiel-API-Proxys verwenden

<ph type="x-smartling-placeholder"></ph> Sie sehen die Dokumentation zu Apigee Edge.
Gehen Sie zur Apigee X-Dokumentation.
Weitere Informationen

Vorbereitung

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

Zur Verwendung von Beispielen benötigen Sie außerdem Folgendes:

Tool Beschreibung
Git Die Beispiele befinden sich auf GitHub. Wenn Sie Git nicht installiert haben, finden Sie weitere Informationen unter Anleitung zum Einrichten von Git in 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- auf einem Mac mit installiertem XCode und an vielen anderen Stellen auf einem Windows-Computer mit installiertem Cygwin.

Informationen zum Abrufen von Python finden Sie in der Python-Downloadseite

curl In den Beispiel-Einrichtungsskripts wird ebenfalls curl verwendet. Prüfen Sie, ob curl installiert und in Ihrem Pfad verfügbar ist. (Führen Sie den Befehl which curl aus, um zu sehen, ob er Ihres Systems).
dos2unix Wenn Sie Cygwin unter Windows ausführen, benötigen Sie möglicherweise auch die Datei dos2unix Dienstprogramm. Über das 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 importieren und bereitstellen Proxys

Importieren Sie die Beispiele und stellen Sie sie ü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 nach der Datei setenv.sh.
  3. Bearbeiten Sie diese Datei, um Ihre Organisation, die mit Ihrem Nutzernamen verknüpfte E-Mail-Adresse, und der Umgebung (Produktion oder Test), in der Sie die API-Proxys bereitstellen möchten.
  4. Nachdem Sie setenv.sh bearbeitet haben, führen Sie den folgenden Befehl aus:
    sh deploy_all.sh

    Dieses Skript stellt alle API-Proxy-Beispiele in Ihrer Organisation bereit. (Der Prozess dauert 3–4 minutes.) Befolgen Sie die Aufforderungen zur Bereitstellung von API-Produkten, Entwicklern und Apps (die für OAuth.

  5. Wechseln Sie nach Abschluss des Bereitstellungsskripts zum Verzeichnis "sample-proxies". Im Verzeichnis sample-proxies finden Sie ein Verzeichnis pro Beispiel-Proxy. In jeder ist die Datei README.md mit Informationen zur Ausführung des Beispiels und zwei Skripts, wenn Sie kleine Änderungen an den Beispielen vornehmen, sie bereitstellen und dann aufrufen, welche Auswirkungen die Änderung hatte: <ph type="x-smartling-placeholder">
      </ph>
    • invoke.sh: Führen Sie dieses Skript aus, um die bereitgestellte Version der API aufzurufen. Proxy.
    • deploy.sh: Führen Sie dieses Skript aus, um den API-Proxy bereitzustellen, nachdem Sie Änderungen.

Beispiel-API-Proxys aufrufen

Jedem Beispiel-Proxy ist ein Shell-Skript zugeordnet, mit dem der API-Proxy aufgerufen werden kann. nachdem Sie es bereitgestellt haben.

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

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 üblicherweise zum Ändern, Bereitstellen und Aufrufen verwendet. So können Sie kleine Änderungen vornehmen und dann sehen, welche Auswirkungen sie auf die Antwort haben.

Um einen Beispiel-API-Proxy so zu ändern, dass er auf einen anderen Back-End-Dienst verweist, ändern Sie die XML-Konfigurationsdatei an folgendem Speicherort:

/apiproxy/targets/target_name.xml

Um das API-Schlüsselbeispiel beispielsweise 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, gehen Sie folgendermaßen vor: ä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 wie im folgenden Beispiel bereit:

sh deploy.sh

Die anderen API-Proxys können auf die gleiche Weise geändert werden, um die API-Proxy-Funktion zu nutzen. mit Ihren vorhandenen Zieldiensten vergleichen. In einigen Fällen hängt das Verhalten des API-Proxys jedoch von Nachrichtenformate, sodass die Proxys möglicherweise zusätzliche Konfigurationsänderungen erfordern.