Was ist der Apigee Emulator?

Diese Seite gilt für Apigee und Apigee Hybrid.

Apigee Edge-Dokumentation aufrufen

Hinweis: Öffnen Sie einen Arbeitsbereich, bevor Sie einen Emulator einrichten. Weitere Informationen finden Sie unter Apigee-Arbeitsbereich verwalten.

Der Apigee-Emulator ist ein benutzerdefiniertes Docker-Image, das Entwicklern öffentlich zur Verfügung gestellt wird, um API-Proxys in einer lokalen Entwicklungsumgebung bereitzustellen und zu testen. Docker-Images werden regelmäßig in gcr veröffentlicht.

Wenn Sie zum Bereitstellen und Testen Ihres ersten API-Proxys bereit sind, müssen Sie über den Abschnitt "Emulatoren" die Emulatorversionen und den Lebenszyklus der eingerichteten Emulatoren aufrufen und verwalten.

Hinweis:Die Bilder und Beispiele in diesem Leitfaden dienen nur zu Referenzzwecken und zeigen möglicherweise nicht die neueste Apigee Emulator-Version. Verwenden Sie immer die neueste stabile Version des Apigee Emulators, die Ihren Anforderungen entspricht. Weitere Informationen finden Sie unter Emulatorversion auswählen.

In diesem Abschnitt haben Sie folgende Möglichkeiten:

• Die verschiedenen installierten Emulatorversionen und die pro Emulatorversion erstellten Container anzeigen, einschließlich ihrer Docker- und Laufzeitinformationen sowie ihrer Kontroll- und Trafficports.

• Die Ansicht der Apigee Emulator-Container hinzufügen, löschen, starten, stoppen, zurücksetzen und aktualisieren, wie unter Apigee Emulator verwalten beschrieben.

• Bereitgestellte Anwendungen ansehen (siehe Umgebungen bereitstellen)

• Aktive Testressourcen anzeigen (siehe Testressourcen in den Apigee Emulator exportieren)

Apigee Emulator verwalten

Verwalten Sie den Apigee Emulator wie in den folgenden Abschnitten beschrieben.

Hinweis: Docker muss auf Ihrem System installiert sein und ausgeführt werden, damit der Apigee Emulator installiert und ausgeführt werden kann.

Emulatorversion wählen

Standardmäßig wird im Ordner emulator eine stabile Version angezeigt. Sie können jedoch je nach Bedarf eine andere Version auswählen.

1. Rufen Sie eine Liste der Versionen des Apigee-Emulators mit einer der folgenden Methoden auf und notieren Sie sich den Tag-Wert:

   • Verwenden Sie die Google Artifact Registry. Weitere Informationen finden Sie in der Dokumentation und in der Benutzeroberfläche.

     

   • Verwenden Sie Docker Hub.

     

2. Klicken Sie auf Verwalten > Einstellungen und suchen Sie nach apigee emulators, um eine Apigee-Emulator-Version zur Cloud Code-Erweiterung hinzuzufügen.

3. Klicken Sie auf Element hinzufügen.

4. Geben Sie den in Schritt 1 ermittelten Tag-Wert ein. Beispiel: 1.10.0 oder google/apigee-emulator:1.10.0.

5. Klicken Sie auf OK.

6. Der neu hinzugefügte Emulator wird im Ordner emulator angezeigt.

Apigee Emulator installieren

So installieren Sie den Apigee Emulator:

1. Maximieren Sie den Ordner emulators in Ihrem Arbeitsbereich.

2. Bewegen Sie den Mauszeiger auf die zu installierende Apigee Emulator-Version.

3. Klicken Sie auf .

   

4. Fügen Sie einen Container hinzu. Folgen Sie dazu der Anleitung unter Container für den Apigee-Emulator hinzufügen.

   Emulator.

Das neueste Image der ausgewählten Apigee Emulator-Version wird installiert. Nach der Installation wird die folgende Meldung Emulator installed successfully angezeigt und der Containerstatus des Apigee Emulators ändert sich in Bereit.

Container für den Apigee Emulator hinzufügen

So fügen Sie einen Container für den Apigee Emulator über die UI hinzu:

1. Maximieren Sie den Ordner emulators.

   

2. Bewegen Sie den Mauszeiger auf den Apigee Emulator, für den Sie einen Container hinzufügen möchten.

3. Klicken Sie auf + (Pluszeichen).

4. Geben Sie einen eindeutigen Namen für den Apigee Emulator-Container ein und drücken Sie die Eingabetaste. Geben Sie alphanumerische Zeichen, Bindestriche (-) oder Unterstriche (_) ein.

5. Geben Sie den numerischen Wert ein, der als Kontrollport für den Apigee Emulator-Container verwendet werden soll, und drücken Sie die Eingabetaste. Der Kontrollport muss für alle Container eindeutig sein. Der Standardwert ist 8080.

   Wichtig! Der Steuerungsport muss eindeutig sein und darf von keiner anderen Komponente verwendet werden.

6. Geben Sie den numerischen Wert ein, der als Trafficport für den Apigee Emulator-Container verwendet werden soll, und drücken Sie die Eingabetaste. Der Trafficport muss in allen Containern eindeutig sein. Der Standardwert ist 8998.

   Wichtig! Der Trafficport muss eindeutig sein und darf von keiner anderen Komponente verwendet werden.

Der Container wird hinzugefügt.

Statusinformationen für den Apigee Emulator ansehen

Rufen Sie Statusinformationen für den Apigee-Emulator auf, wie in den folgenden Abschnitten beschrieben.

Benutzeroberfläche verwenden

Um Statusinformationen zum Apigee Emulator einschließlich seiner Docker- und Laufzeitinformationen anzusehen, maximieren Sie den Container im Abschnitt Emulatoren. Die angezeigten Informationen stimmen mit der verwendeten Apigee-Emulator-Version überein.

Docker-Befehlszeile verwenden

Führen Sie docker ps auf dem Tab Terminal aus, um Informationen zum Containerstatus für den Apigee Emulator und die konfigurierten Ports aufzurufen. Im Folgenden finden Sie ein Beispiel für eine Antwort. Die tatsächlich angezeigte Antwort hängt von der verwendeten Apigee-Emulatorversion ab:

CONTAINER ID   IMAGE                                COMMAND       CREATED        STATUS        PORTS                                      NAMES
33756b8c5c5b   ...apigee-emulator:1.11.0   "/usr/bin…"   10 hours ago   Up 10 hours   7000-7001/tcp, 0.0.0.0:8080->8080/tcp...   apigee-emulator

Weitere Informationen finden Sie unter Docker-Container der Apigee-Laufzeit anpassen.

Apigee Emulator starten

Verwalten Sie den Apigee Emulator wie in den folgenden Abschnitten beschrieben.

Benutzeroberfläche verwenden

Platzieren Sie zum Starten des Apigee Emulator den Mauszeiger auf den Container, den Sie starten möchten, und klicken Sie auf .

Docker-Befehlszeile verwenden

Um den Apigee Emulator zu starten, führen Sie docker start CONTAINER_NAME

auf dem Tab Terminal aus.

Der Status ist auf Ready gesetzt:

Weitere Informationen finden Sie unter Docker-Container der Apigee-Laufzeit anpassen.

Apigee Emulator zurücksetzen

Setzen Sie den Apigee Emulator zurück, um alle Bereitstellungen und exportierten Testressourcen zu entfernen, wie in den folgenden Abschnitten beschrieben.

Benutzeroberfläche verwenden

Um den Apigee Emulator zurückzusetzen, platzieren Sie den Mauszeiger auf den Apigee Emulator-Container im Abschnitt Emulatoren und klicken Sie auf .

Der Apigee Emulator wird zurückgesetzt und der Status ist auf Ready gesetzt:

Die folgenden Informationen werden auf dem Tab Ausgabe angezeigt:

Resetting the Apigee Emulator
Reset completed

Weitere Informationen finden Sie unter Docker-Container der Apigee-Laufzeit anpassen.

Apigee Emulator neu starten

Führen Sie docker restart CONTAINER_NAME auf dem Tab Terminal aus, um den Apigee Emulator neu zu starten. Beispiel: docker restart MyContainer

Apigee Emulator aktualisieren

Wenn der Apigee-Emulator nicht mit der neuesten Version synchron ist, können Sie Ihre installierte Version über die UI oder die Docker-Befehlszeile aktualisieren, wie in den folgenden Abschnitten beschrieben.

Benutzeroberfläche verwenden

Platzieren Sie zum Aktualisieren des Apigee Emulator den Mauszeiger im Abschnitt Emulatoren über den Apigee Emulator und klicken Sie auf .

Docker-Befehlszeile verwenden

Führen Sie die folgenden Docker-Befehle auf dem Tab Terminal aus, um den Apigee-Emulator zu aktualisieren: mit der aktuellsten geeigneten Version:

• Führen Sie docker ps aus, um den Image-Namen abzurufen. Beispiel: gcr.io/apigee-release/hybrid/apigee-emulator:EMULATOR_VERSION

• Führen Sie docker pull IMAGE_NAME aus, um das Apigee Emulator-Installations-Image zu aktualisieren. Beispiel: docker pull gcr.io/apigee-release/hybrid/apigee-emulator:EMULATOR_VERSION

Der Apigee Emulator wird aktualisiert und die folgende Meldung wird angezeigt: Emulator version is up to date

Weitere Informationen finden Sie unter Docker-Container der Apigee-Laufzeit anpassen.

Apigee Emulator beenden

Beenden Sie den Apigee Emulator über die UI oder die Docker-Befehlszeile, wie in den folgenden Abschnitten beschrieben.

Benutzeroberfläche verwenden

Um den Apigee Emulator zu beenden, platzieren Sie den Mauszeiger über den Apigee Emulator-Container im Abschnitt Emulatoren und klicken Sie auf .

Docker-Befehlszeile verwenden

Führen Sie docker stop CONTAINER_NAME auf dem Tab Terminal aus, um den Apigee Emulator zu beenden.

Der Apigee Emulator wird angehalten und der Status ändert sich in Not running:

Weitere Informationen finden Sie unter Docker-Container der Apigee-Laufzeit anpassen.

Container für den Apigee Emulator löschen

Löschen Sie einen Container für den Apigee Emulator über die UI oder die Docker-Befehlszeile, wie in den folgenden Abschnitten beschrieben.

Benutzeroberfläche verwenden

Platzieren Sie zum Löschen des Apigee Emulator den Mauszeiger über den Apigee Emulator-Container im Abschnitt Emulatoren und klicken Sie auf .

Docker-Befehlszeile verwenden

Führen Sie die folgenden Docker-Befehle auf dem Tab Terminal aus, um einen Container für den Apigee-Emulator zu löschen:

• Führen Sie docker stop CONTAINER_NAME aus, um das Installations-Image des Apigee Emulators zu beenden (falls es noch nicht angehalten ist). Beispiel: docker stop MyContainer

• Führen Sie docker rm CONTAINER_NAME aus, um das Installations-Image des Apigee Emulators zu beenden. Beispiel: docker rm MyContainer

Der Container wird gelöscht.

Weitere Informationen finden Sie unter Docker-Container der Apigee-Laufzeit anpassen.

Docker-Container der Apigee-Laufzeit anpassen

Sie können die Docker-Befehlszeile, die zur Steuerung der Apigee-Emulator-Instanzen verwendet wird, mit den folgenden Optionen anpassen.

Hinweis: Die Anpassung des Docker-Containers der Apigee-Laufzeit ist nicht erforderlich. Wenn nicht angegeben, werden die Standardwerte der Optionen verwendet. Alle Änderungen an den Optionen gelten nur für die Container, die nach der Änderung der Optionen erstellt wurden. Wenn die Optionen auf vorhandene Container angewendet werden sollen, müssen Sie sie neu erstellen.

Wahltaste	Beschreibung
additionalArguments	Fügen Sie ein oder mehrere Argumente hinzu. Die Argumente werden dem Befehl docker run genau wie angegeben hinzugefügt. Die Standardeinstellung ist "" (keine).
detached	Damit wird festgelegt, ob die Option --detached beim Ausführen des Containers verwendet wird. Die Standardeinstellung ist true.
dns	Steuert das DNS-Dienst--dns-Flag, wie unter DNS-Dienste beschrieben. Die Standardeinstellung ist 8.8.8.8.
environmentVariables	Fügen Sie dem Befehl docker run Umgebungsvariablen hinzu, wie unter Optionen beschrieben. Die Werte werden, sofern angegeben, mit -e name=value zum Befehl docker run hinzugefügt. Die Standardliste enthält "XTERM": "xterm-256color".
labels	Fügen Sie ein oder mehrere Labels hinzu, die dem Container hinzugefügt werden sollen. Die Labels werden mit -l label:value dem Befehl docker run hinzugefügt. Die Standardeinstellung ist none.
privileged	Damit wird festgelegt, ob die Option --privileged beim Ausführen des Containers verwendet wird. Die Standardeinstellung ist true.
volumes	Fügen Sie ein oder mehrere Volumes hinzu, die im Container bereitgestellt werden sollen. Die Volumes werden mit -v label:value dem Befehl docker run hinzugefügt. Die Standardeinstellung ist none.

So passen Sie den Docker-Container der Apigee-Laufzeit an:

1. Diese Funktion ist im Rahmen des Insiders-Builds (Version 1.21.0 und höher) verfügbar. Installieren Sie den Insider-Build, wie unter Insider-Builds installieren beschrieben.

2. Klicken Sie auf Verwalten > Einstellungen und suchen Sie nach apigee docker.

3. Klicken Sie unter Cloudcode > Apigee: Docker-Optionen auf In settings.json bearbeiten. Die anpassbaren Optionen werden in der Datei settings.json angezeigt.

   "cloudcode.apigee.dockerOptions": {
     "environmentVariables": {
         "XTERM": "xterm-256-color"
     },
     "dns": "8.8.8.8",
     "detached": true
     "privileged": true,
     "labels": {},
     "volumes": {},
     "additionalArguments":""
   }

4. Bearbeiten Sie die Optionen und speichern Sie die Datei.

Apigee Emulator für die Unterstützung der dienstkontobasierten Authentifizierung anpassen

Beim Testen der Proxys, die von der auf Google Cloud-Dienstkonten basierenden Authentifizierung abhängen, benötigt der Apigee Emulator Zugriff auf den Google-Dienstkontoschlüssel. Führen Sie die Schritte aus, um Ihren Apigee Emulator für die Unterstützung der dienstkontobasierten Authentifizierung zu konfigurieren.

Dienstkontoschlüssel erstellen und herunterladen

Erstellen Sie ein Google Cloud-Dienstkonto mit der Rolle Service Account Token Creator. Dies ist erforderlich, damit der Apigee Emulator Dienstkonten unterstützen kann. Erstellen Sie einen Schlüssel für das Dienstkonto, wie unter Dienstkontoschlüssel erstellen erläutert.

Laden Sie den Schlüssel in das lokale Dateisystem herunter, damit er für den Apigee Emulator bereitgestellt werden kann.

Hinweis: Dienstkontoschlüssel stellen ein Sicherheitsrisiko dar, wenn sie nicht ordnungsgemäß verwaltet werden. Sie sind für die Sicherheit des privaten Schlüssels und für andere Vorgänge verantwortlich, die unter Best Practices für die Verwaltung von Dienstkontoschlüsseln beschrieben werden. Wenn Sie keinen Dienstkontoschlüssel erstellen können, ist das Erstellen von Dienstkontoschlüsseln für Ihre Organisation möglicherweise deaktiviert. Weitere Informationen finden Sie unter Standardmäßig sichere Organisationsressourcen verwalten.

Apigee Emulator konfigurieren

Die in diesem Abschnitt definierten Einstellungen gelten nur für die Docker-Containerinstanzen, die nach dem Speichern der Einstellungen erstellt werden.

So konfigurieren Sie die Apigee Emulator-Einstellungen:

1. Öffnen Sie die Docker-Optionen, wie unter Docker-Container der Apigee-Laufzeit anpassen beschrieben.

   Container.

2. Fügen Sie im Bereich volumes der Docker-Optionen ein neues Volume hinzu, damit der Pfad des heruntergeladenen Dienstkontoschlüssels im Container verfügbar ist. Wenn der Schlüssel im Pfad /opt/apigee/keys/apigee-sa-key.json heruntergeladen wurde, stellt die folgende Einstellung den Inhalt von /opt/apigee/keys im Pfad /emulator/keys innerhalb des Containers bereit:

   "volumes": {
     "/opt/apigee/keys":"/emulator/keys"
   }

3. Fügen Sie im Bereich environmentVariables der Docker-Optionen die Variable GOOGLE_APPLICATION_CREDENTIALS hinzu, die auf die Datei im bereitgestellten Pfad verweist:

   "environmentVariables": {
     "GOOGLE_APPLICATION_CREDENTIALS":"/emulator/keys/apigee-sa-key.json"
   }

4. Speichern Sie die Einstellungen und erstellen Sie eine neue Containerinstanz zum Testen.

Im folgenden Beispiel wird gezeigt, wie ein Google-Dienstkontoschlüssel mit dem Apigee Emulator verknüpft wird.

"cloudcode.apigee.dockerOptions": {
      "environmentVariables": {
          "XTERM": "xterm-256-color",
          "GOOGLE_APPLICATION_CREDENTIALS":"/emulator/keys/apigee-sa-key.json"
      },
      "dns": "8.8.8.8",
      "detached": true
      "privileged": true,
      "labels": {},
      "volumes": {
         "/opt/apigee/keys":"/emulator/keys"
      },
      "additionalArguments":""
    }

Apigee Emulator für die Unterstützung von HTTP-Weiterleitungsproxy konfigurieren

Die in diesem Abschnitt definierten Einstellungen gelten nur für Emulatorversionen ab 1.11.0.

Oft können die mit einem Proxy verknüpften Backend-Ziele nur über einen HTTP-Weiterleitungsproxy erreicht werden. Der Apigee-Emulator kann so konfiguriert werden, dass er den Forward-Proxy verwendet, während er über eine Umgebungsvariable namens FORWARD_PROXY eine Verbindung zu Zielen herstellt.

Die in diesem Abschnitt definierten Einstellungen gelten nur für die Docker-Containerinstanzen, die nach dem Speichern der Einstellungen erstellt werden.

So konfigurieren Sie die Apigee Emulator-Einstellungen:

1. Öffnen Sie die Docker-Optionen, wie unter Docker-Container der Apigee-Laufzeit anpassen beschrieben.

2. Fügen Sie im Bereich environmentVariables der Docker-Optionen die Variable FORWARD_PROXY hinzu, die auf die Adresse des Forward-Proxy als HTTP-URL verweist.

   "environmentVariables": {
     "FORWARD_PROXY":"http://proxy_host:proxy_port"
   }

3. Speichern Sie die Einstellungen und erstellen Sie eine neue Containerinstanz zum Testen.