Schritt 7: In einer Apigee-Umgebung bereitstellen

Diese Seite gilt für Apigee und Apigee Hybrid.

Apigee Edge-Dokumentation aufrufen

Nachdem Sie die Entwicklung und das Testen mit Apigee in VS Code abgeschlossen haben, können Sie die API als Archiv in einer Apigee-Umgebung bereitstellen. In diesem Schritt erstellen Sie eine Apigee-Umgebung, die die Archivbereitstellung unterstützt, und erstellen ein Archiv Ihrer API-Proxy-Konfiguration in der Apigee-Umgebung.

  1. Führen Sie die Schritte unter Umgebung erstellen aus, um Folgendes durchzuführen:
    1. Erstellen Sie eine neue dev-Umgebung in Ihrer Apigee-Organisation und aktivieren Sie Archiv als Bereitstellungstyp Verwenden Sie die UI oder die API

      Beispiel:

      Dialogfeld "Neue Umgebung" mit den Einstellungen für die Option "Archivtyp"

    2. Hängen Sie die Umgebung mithilfe der Instances Attachment API an die Laufzeitinstanz an.

      Dieser Befehl löst einen Vorgang mit langer Ausführungszeit aus. Prüfen Sie, bevor Sie fortfahren, ob die Umgebung an die Laufzeit angehängt wurde.

    3. Erstellen Sie mit der API Umgebungsgruppen erstellen eine Umgebungsgruppe, wenn Sie noch keine haben.

      Prüfen Sie, ob die Umgebungsgruppe erstellt wurde, bevor Sie fortfahren. Sie können dann den Status der neuen Gruppe mithilfe einer Anfrage wie der folgenden prüfen:

      curl -i -H "$AUTH" -H "Content-Type:application/json" \
        "https://apigee.googleapis.com/v1/organizations/$PROJECT_ID/environments/ENVIRONMENT_NAME"
    4. Hängen Sie die neue Umgebung mithilfe der Environment Group Attachment API an die Umgebungsgruppe an.

      Durch Anhängen einer Umgebung an die Gruppe sind die Proxys in dieser Umgebung nur über die Hostnamen in der Gruppe routingfähig. Dadurch wird ein lang andauernder Vorgang ausgelöst, der einige Minuten dauern kann. Wir empfehlen, ein bis zwei Minuten zu warten, bevor Sie mit dem nächsten Schritt fortfahren. In der Zwischenzeit können Sie den Status des Vorgangs wie zuvor prüfen.

  2. Ein Archiv Ihrer API-Proxy-Konfiguration in der Apigee-Umgebung bereitstellen
    1. Gehen Sie auf dem Tab Terminal in Apigee VS Code zum Verzeichnis myapigeeworkspace.
      cd myapigeeworkspace

      Wenn Sie ls ausführen, sollte das Verzeichnis den Ordner src enthalten.

    2. Führen Sie dazu diesen Befehl aus:
      gcloud beta apigee archives deploy --environment=dev --labels=release=052021

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

      Using Apigee organization dev
      Waiting for operation [b64c2665-b5ac-43cc-9e2d-232e8895c2ed] to complete...done
  3. Führen Sie auf dem Tab Terminal den folgenden Befehl aus, um die API zu testen:
    curl https://INTERNAL_LOAD_BALANCER_IP/helloworld /
      -H "Host: ENV_GROUP_HOSTNAME" 

    Weitere Informationen zu den Variablen in diesem Beispiel und zum Einrichten des API-Zugriffs finden Sie unter Beispielproxy bereitstellen.

    Die folgende Fehlermeldung wird angezeigt:

    {"fault":{"faultstring":"Failed to resolve API Key variable request.queryparam.apikey",
      "detail":{"errorcode":"steps.oauth.v2.FailedToResolveAPIKey"}}}
    

    Sie müssen ein API-Produkt erstellen, das die helloworld API enthält, und einen Entwickler dann beim API-Produkt erstellen und registrieren, um einen API-Schlüssel zu erhalten.

  4. Erstellen Sie einen API-Schlüssel.
      1. Erstellen Sie einen API-Proxy mithilfe der Apigee-Benutzeroberfläche.
      2. Wählen Sie Publish > API Products aus.
      3. Klicken Sie auf + Erstellen.
      4. Geben Sie die Produktdetails für Ihr API-Produkt ein.
      5. Geben Sie folgende Informationen in die entsprechenden Felder ein:
        Feld Einstellung
        Name: myproduct
        Display name: myproduct
        Environment: dev
        Access: Öffentlich
        Quota: Leer lassen
        Allowed OAuth scope: Leer lassen
      6. Klicken Sie unter Vorgänge auf + Vorgang hinzufügen.
      7. Wählen Sie unter Quelle aus dem Drop-down-Menü „API Proxy“ die Option helloworld aus.
      8. Geben Sie unter Vorgang im Feld "Pfad" / ein.

        Übernehmen Sie die Standardwerte der restlichen Felder.

      9. Klicken Sie auf Speichern, um den Vorgang zu speichern.
      10. Klicken Sie auf Speichern, um das API-Produkt zu speichern.
    1. Erstellen Sie einen Entwickler in Ihrer Organisation:
      1. Klicken Sie im seitlichen Navigationsmenü auf Veröffentlichen > Entwickler.
      2. Klicken Sie auf + Entwickler.
      3. Geben Sie folgende Informationen in die entsprechenden Felder ein:
        Feld Einstellung
        First Name: Alex
        Last Name: Hamilton
        Username: ahamilton
        Email: ahamilton@example.com
      4. Klicken Sie auf Erstellen.
    2. App registrieren:
      1. Wählen Sie Veröffentlichen > Apps aus.
      2. Klicken Sie auf + App.
      3. Geben Sie folgende Informationen in die entsprechenden Felder ein:
        Feld Einstellung
        Name: myapp
        Display name: myapp
        Developer: ahamilton@example.com
        Callback URL: Leer lassen
        Notes: Leer lassen
        Expiry: Nie
        Product:
        1. Klicken Sie auf Produkt hinzufügen.
        2. Wählen Sie myproduct aus.
        3. Klicken Sie auf Hinzufügen.
        Custom attributes: Leer lassen
    3. Kopieren Sie den API-Schlüssel.
      1. Klicken Sie auf der Seite "Apps" (Veröffentlichen > Apps) auf myapp.
      2. Klicken Sie auf der Seite myapp im Abschnitt Anmeldedaten neben Schlüssel auf Anzeigen. Beachten Sie, dass der API-Schlüssel mit dem von Ihnen erstellten API-Produkt verknüpft ist.
      3. Wählen Sie den API-Schlüssel aus und kopieren Sie ihn.
  5. Führen Sie den curl-Aufruf noch einmal aus und übergeben Sie damit den API-Schlüssel mit dem Abfrageparameter apikey:
    curl -v https://$PUBLIC_FACING_IP/helloworld?apikey=ZQA5euYtNeJ7ZCGCJMpvd6F2BZOmxOzY

    Die folgende Antwort wird zurückgegeben:

    {
      "root": {
        "city": "San Jose",
        "firstName": "John",
        "lastName": "Doe",
        "state": "CA"
      }
    }

Das wars! Sie haben Ihr API-Archiv erfolgreich in einer Apigee-Umgebung bereitgestellt.

Im nächsten Schritt stufen Sie Ihr API-Archiv in eine Apigee-Produktionsumgebung hoch.

1 2 3 4 5 6 7 (WEITER) Schritt 8: Archiv in Produktion hochstufen