Erste Schritte mit Cloud Endpoints für die flexible App Engine-Umgebung mit ESP

In dieser Anleitung wird erläutert, wie Sie eine Beispiel-API und den Extensible Service Proxy (ESP) konfigurieren und bereitstellen, um sie auf einer Instanz in der flexiblen App Engine-Umgebung auszuführen. Die REST API des Beispielcodes wird mit der OpenAPI-Spezifikation beschrieben. Sie erfahren außerdem, wie Sie einen API-Schlüssel erstellen und in Anfragen an die API verwenden.

Eine Übersicht über Cloud Endpoints finden Sie in den Abschnitten Über Cloud Endpoints und Endpoints-Architektur.

Ziele

Orientieren Sie sich beim Durcharbeiten der Anleitung an der folgenden Aufgabenliste. Alle Aufgaben sind erforderlich, um Anfragen sicher an die API senden zu können.

  1. Richten Sie ein Google Cloud Platform-Projekt ein, installieren Sie die erforderliche Software und erstellen Sie eine App Engine-Anwendung. Siehe Vorbereitung.
  2. Laden Sie den Beispielcode herunter. Siehe Beispielcode abrufen.
  3. Konfigurieren Sie die Datei openapi-appengine.yaml, mit der Endpoints konfiguriert wird. Siehe Endpoints konfigurieren.
  4. Endpoints-Konfiguration bereitstellen, um einen Endpoints-Dienst zu erstellen. Siehe Endpoints-Konfiguration bereitstellen.
  5. Die API und den ESP in App Engine bereitstellen. Siehe API-Back-End bereitstellen.
  6. Senden Sie eine Anfrage an die API. Siehe Anfrage an die API senden.
  7. Verfolgen Sie die API-Aktivitäten. Siehe API-Aktivitäten verfolgen.
  8. Vermeiden Sie Gebühren, die Ihrem Google Cloud-Konto in Rechnung gestellt werden. Siehe Bereinigen.

Kosten

In dieser Anleitung werden die folgenden kostenpflichtigen Komponenten von Google Cloud verwendet:

Mit dem Preisrechner können Sie eine Kostenschätzung für Ihre voraussichtliche Nutzung vornehmen. Neuen Google Cloud-Nutzern steht möglicherweise eine kostenlose Testversion zur Verfügung.

Nach Abschluss dieser Anleitung können Sie weitere Kosten vermeiden, indem Sie die erstellten Ressourcen löschen. Weitere Informationen finden Sie unter Bereinigen.

Hinweise

  1. Melden Sie sich bei Ihrem Google-Konto an.

    Wenn Sie noch kein Konto haben, melden Sie sich hier für ein neues Konto an.

  2. Wählen Sie in der Cloud Console auf der Seite für die Projektauswahl ein Cloud-Projekt aus oder erstellen Sie eines.

    Zur Projektauswahl

  3. Die Abrechnung für das Google Cloud-Projekt muss aktiviert sein. So prüfen Sie, ob die Abrechnung für Ihr Projekt aktiviert ist.

  4. Notieren Sie sich die Projekt-ID, da sie später benötigt wird.
  5. Sie benötigen eine Anwendung, um Anfragen an die Beispiel-API zu senden.

    • Nutzer von Linux und macOS: Diese Anleitung enthält ein Beispiel, bei dem curl verwendet wird. Das Tool ist normalerweise auf Ihrem Betriebssystem vorinstalliert. Wenn curl nicht installiert ist, können Sie es von der Seite Releases und Downloads für curl herunterladen.
    • Nutzer von Windows: Diese Anleitung enthält ein Beispiel, bei dem Invoke-WebRequest verwendet wird. Der Befehl wird in PowerShell ab Version 3.0 unterstützt.
  6. Laden Sie das Cloud SDK herunter.
  7. Aktualisieren Sie das Cloud SDK und installieren Sie die Endpoints-Komponenten.
    gcloud components update
  8. Das Cloud SDK (gcloud) muss berechtigt sein, auf Ihre Daten und Dienste auf Google Cloud zuzugreifen:
    gcloud auth login
    Ein neuer Browsertab wird geöffnet. Wählen Sie dort ein Konto aus.
  9. Legen Sie für das Standardprojekt Ihre Projekt-ID fest:
    gcloud config set project YOUR_PROJECT_ID

    Ersetzen Sie YOUR_PROJECT_ID durch Ihre Projekt-ID. Wenn Sie weitere Google Cloud-Projekte mit gcloud verwalten möchten, lesen Sie Cloud SDK-Konfigurationen verwalten.

  10. Wählen Sie die Region aus, in der Sie die App Engine-Anwendung erstellen möchten. Führen Sie den folgenden Befehl aus, um eine Liste der Regionen abzurufen:
    gcloud app regions list
  11. Erstellen Sie eine App Engine-Anwendung. Ersetzen Sie YOUR_PROJECT_ID durch Ihre Google Cloud-Projekt-ID und YOUR_REGION durch die Region, in der die App Engine-Anwendung erstellt werden soll.
      gcloud app create \
      --project=YOUR_PROJECT_ID \
      --region=YOUR_REGION
    

Beispielcode abrufen

Java

So können Sie die Beispiel-API klonen oder herunterladen:

  1. Der Beispielcode verwendet Maven. Wenn Maven 3.3.9 oder höher nicht auf Ihrem System installiert ist, können Sie das Tool hier herunterladen und installieren.
  2. Klonen Sie das Repository der Beispielanwendung auf Ihren lokalen Computer:
    git clone https://github.com/GoogleCloudPlatform/java-docs-samples

    Sie können auch das Beispiel als ZIP-Datei herunterladen und entpacken.

  3. Wechseln Sie zu dem Verzeichnis, das den Beispielcode enthält:
    cd java-docs-samples/endpoints/getting-started
Python

So können Sie die Beispiel-API klonen oder herunterladen:

  1. Klonen Sie das Repository der Beispielanwendung auf Ihren lokalen Computer:
    git clone https://github.com/GoogleCloudPlatform/python-docs-samples

    Sie können auch das Beispiel als ZIP-Datei herunterladen und entpacken.

  2. Wechseln Sie zu dem Verzeichnis, das den Beispielcode enthält:
    cd python-docs-samples/endpoints/getting-started
Go

So können Sie die Beispiel-API klonen oder herunterladen:

  1. Prüfen Sie, ob die Umgebungsvariable GOPATH festgelegt ist.
  2. Klonen Sie das Repository der Beispielanwendung auf Ihren lokalen Computer:
    go get -u -d github.com/GoogleCloudPlatform/golang-samples/endpoints/getting-started
  3. Wechseln Sie zu dem Verzeichnis, das den Beispielcode enthält:
    cd $GOPATH/src/github.com/GoogleCloudPlatform/golang-samples/endpoints/getting-started
PHP

So können Sie die Beispiel-API klonen oder herunterladen:

  1. Klonen Sie das Repository der Beispielanwendung auf Ihren lokalen Computer:
    git clone https://github.com/GoogleCloudPlatform/php-docs-samples

    Sie können auch das Beispiel als ZIP-Datei herunterladen und entpacken.

  2. Wechseln Sie zu dem Verzeichnis, das den Beispielcode enthält:
    cd php-docs-samples/endpoints/getting-started
Ruby

So können Sie die Beispiel-API klonen oder herunterladen:

  1. Klonen Sie das Repository der Beispielanwendung auf Ihren lokalen Computer:
    git clone https://github.com/GoogleCloudPlatform/ruby-docs-samples

    Sie können auch das Beispiel als ZIP-Datei herunterladen und entpacken.

  2. Wechseln Sie zu dem Verzeichnis, das den Beispielcode enthält:
    cd ruby-docs-samples/endpoints/getting-started
NodeJS

So können Sie die Beispiel-API klonen oder herunterladen:

  1. Klonen Sie das Repository der Beispielanwendung auf Ihren lokalen Computer:
    git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples

    Sie können auch das Beispiel als ZIP-Datei herunterladen und entpacken.

  2. Wechseln Sie zu dem Verzeichnis, das den Beispielcode enthält:
    cd nodejs-docs-samples/endpoints/getting-started

Endpoints konfigurieren

Der Beispielcode enthält die OpenAPI-Konfigurationsdatei openapi-appengine.yaml, die auf der OpenAPI-Spezifikation Version 2.0 beruht.

So konfigurieren Sie Endpoints:
  1. Öffnen Sie im Beispielcodeverzeichnis die Konfigurationsdatei openapi-appengine.yaml.

    Wichtige Hinweise:

    • Im Konfigurationsbeispiel sind die Zeilen in der Nähe des Feldes host zu sehen, die Sie ändern müssen. Zum Bereitstellen der Datei openapi-appengine.yaml in Endpoints ist das vollständige OpenAPI-Dokument erforderlich.
    • Die Beispieldatei openapi-appengine.yaml enthält einen Abschnitt zum Konfigurieren der Authentifizierung, der für diese Anleitung nicht benötigt wird. Die Zeilen mit YOUR-SERVICE-ACCOUNT-EMAIL und YOUR-CLIENT-ID brauchen Sie nicht zu konfigurieren.
    • OpenAPI ist eine sprachunabhängige Spezifikation. Die Datei openapi-appengine.yaml für das Beispiel getting-started ist im GitHub-Repository aller Sprachen die gleiche.
  2. Ersetzen Sie in der Zeile mit dem Feld host den Text YOUR-PROJECT-ID durch die ID Ihres Google Cloud-Projekts. Beispiel:
    host: "example-project-12345.appspot.com"
    

Endpoints verwendet den Text im Feld host als Dienstnamen. Wenn Sie die API im App Engine-Back-End bereitstellen, wird automatisch ein DNS-Eintrag mit einem Namen im Format YOUR-PROJECT-ID.appspot.com erstellt.

Informationen zu den Feldern im OpenAPI-Dokument, die für Endpoints erforderlich sind, finden Sie unter Cloud Endpoints konfigurieren.

Endpoints-Konfiguration bereitstellen

Die Endpoints-Konfiguration wird mit dem Befehl gcloud endpoints services deploy bereitgestellt. Dieser Befehl erstellt mithilfe von Service Management einen verwalteten Dienst.

So stellen Sie die Endpoints-Konfiguration bereit:

  1. Sie müssen sich im Verzeichnis endpoints/getting-started befinden.
  2. Laden Sie die Konfiguration hoch und erstellen Sie einen verwalteten Dienst:
    gcloud endpoints services deploy openapi-appengine.yaml
    

Der Befehl gcloud ruft dann die Service Management API auf, um einen verwalteten Dienst mit dem Namen zu erstellen, den Sie im Feld host der Datei openapi-appengine.yaml angegeben haben. In der Service Management API wird der Dienst gemäß den Einstellungen in der Datei openapi-appengine.yaml konfiguriert. Wenn Sie Änderungen an openapi-appengine.yamlopenapi.yaml vornehmen, müssen Sie die Datei noch einmal bereitstellen, um den Endpoints-Dienst zu aktualisieren.

Beim Erstellen und Konfigurieren des Dienstes gibt Service Management Informationen an das Terminal aus. Warnungen mit dem Hinweis, dass für die Pfade in der Datei openapi-appengine.yaml kein API-Schlüssel erforderlich ist, können Sie ignorieren. Nach Abschluss der Dienstkonfiguration wird von Service Management eine Meldung mit der Dienstkonfigurations-ID und dem Dienstnamen angezeigt, die etwa so aussieht:

Service Configuration [2017-02-13r0] uploaded for service [example-project-12345.appspot.com]

Im vorherigen Beispiel ist 2017-02-13r0 die Dienstkonfigurations-ID und example-project-12345.appspot.com der Name des Endpoints-Dienstes. Die Dienstkonfigurations-ID besteht aus einem Datumsstempel und einer Überarbeitungsnummer. Wenn Sie die Datei openapi-appengine.yaml am selben Tag noch einmal bereitstellen, erhöht sich die Überarbeitungsnummer in der Dienstkonfigurations-ID. Sie können die Endpoints-Dienstkonfiguration in der Cloud Console auf der Seite Endpoints > Dienste aufrufen.

Wenn Sie eine Fehlermeldung erhalten, lesen Sie Fehlerbehebung bei der Bereitstellung von Cloud Endpoints-Konfigurationen.

Erforderliche Dienste prüfen

Für Endpoints und ESP müssen mindestens die folgenden Google-Dienste aktiviert sein:
Name Titel
servicemanagement.googleapis.com Service Management API
servicecontrol.googleapis.com Service Control API
endpoints.googleapis.com Google Cloud Endpoints

In der Regel werden die erforderlichen Dienste mit dem Befehl gcloud endpoints services deploy aktiviert. Unter folgenden Umständen kann es vorkommen, dass der Befehl gcloud erfolgreich ausgeführt wird, die erforderlichen Dienste jedoch nicht aktiviert werden:

  • Wenn Sie eine Drittanbieteranwendung wie Terraform verwendet haben und Sie diese Dienste nicht hinzufügen.

  • Wenn Sie die Endpoints-Konfiguration für ein vorhandenes Google Cloud-Projekt bereitgestellt haben, in dem diese Dienste explizit deaktiviert wurden.

Prüfen Sie mit dem folgenden Befehl, ob die erforderlichen Dienste aktiviert sind:

gcloud services list

Wenn die erforderlichen Dienste nicht aufgeführt sind, müssen Sie sie aktivieren:

gcloud services enable servicemanagement.googleapis.com
gcloud services enable servicecontrol.googleapis.com
gcloud services enable endpoints.googleapis.com

Aktivieren Sie auch Ihren Endpoints-Dienst:

gcloud services enable ENDPOINTS_SERVICE_NAME

Zum Ermitteln des ENDPOINTS_SERVICE_NAME haben Sie folgende Möglichkeiten:

  • Rufen Sie nach der Bereitstellung der Endpoints-Konfiguration die Seite Endpoints in der Cloud Console auf. Die Liste der möglichen ENDPOINTS_SERVICE_NAME wird in der Spalte Dienstname angezeigt.

  • Bei OpenAPI ist ENDPOINTS_SERVICE_NAME der Wert, den Sie im Feld host Ihrer OpenAPI-Spezifikation angegeben haben. Bei gRPC ist der ENDPOINTS_SERVICE_NAME das, was Sie im Feld name Ihrer gRPC-Endpoints-Konfiguration angegeben haben.

Weitere Informationen zu den gcloud-Befehlen finden Sie unter gcloud-Dienste.

API-Back-End bereitstellen

Bisher haben Sie zwar das OpenAPI-Dokument für Service Management bereitgestellt, den Code für das API-Back-End haben Sie jedoch noch nicht implementiert. In diesem Abschnitt wird die Bereitstellung der Beispiel-API und des ESPs in App Engine beschrieben.

API-Back-End bereitstellen:

  1. Fügen Sie Ihren Dienstnamen zur Datei app.yaml hinzu:

    Java

    Öffnen Sie die Datei endpoints/getting-started/src/main/appengine/app.yaml.

    endpoints_api_service:
      # The following values are to be replaced by information from the output of
      # 'gcloud endpoints services deploy openapi-appengine.yaml' command.
      name: ENDPOINTS-SERVICE-NAME
      rollout_strategy: managed

    Python

    Öffnen Sie die Datei endpoints/getting-started/app.yaml.

    endpoints_api_service:
      # The following values are to be replaced by information from the output of
      # 'gcloud endpoints services deploy openapi-appengine.yaml' command.
      name: ENDPOINTS-SERVICE-NAME
      rollout_strategy: managed

    Go

    Öffnen Sie die Datei endpoints/getting-started/app.yaml.

    endpoints_api_service:
      # The following values are to be replaced by information from the output of
      # 'gcloud endpoints services deploy openapi-appengine.yaml' command.
      name: ENDPOINTS-SERVICE-NAME
      rollout_strategy: managed

    PHP

    Öffnen Sie die Datei endpoints/getting-started/app.yaml.

    endpoints_api_service:
      # The following values are to be replaced by information from the output of
      # 'gcloud endpoints services deploy openapi-appengine.yaml' command. If you have
      # previously run the deploy command, you can list your existing configuration
      # ids using the 'configs list' command as follows:
      #
      #     gcloud endpoints configs list --service=YOUR-PROJECT-ID.appspot.com
      #
      name: ENDPOINTS-SERVICE-NAME
      rollout_strategy: managed

    Ruby

    Öffnen Sie die Datei endpoints/getting-started/app.yaml.

    endpoints_api_service:
      # The following values are to be replaced by information from the output of
      # 'gcloud endpoints services deploy openapi-appengine.yaml' command.
      name: ENDPOINTS-SERVICE-NAME
      rollout_strategy: managed

    NodeJS

    Öffnen Sie die Datei endpoints/getting-started/app.yaml.

    endpoints_api_service:
      # The following values are to be replaced by information from the output of
      # 'gcloud endpoints services deploy openapi-appengine.yaml' command.
      name: ENDPOINTS-SERVICE-NAME
      rollout_strategy: managed

    Ersetzen Sie ENDPOINTS-SERVICE-NAME durch den Namen Ihres Endpoints-Dienstes. Dies ist der Name, den Sie im Feld host Ihres OpenAPI-Dokuments konfiguriert haben. Beispiel:

    endpoints_api_service:
      name: example-project-12345.appspot.com
      rollout_strategy: managed
    

    Mit der Option rollout_strategy: managed legen Sie fest, dass der ESP die zuletzt bereitgestellte Dienstkonfiguration verwendet. Wenn Sie diese Option innerhalb von 5 Minuten nach der Bereitstellung einer neuen Dienstkonfiguration angeben, erkennt der ESP die Änderung und verwendet automatisch die neue Konfiguration. Wir empfehlen, diese Option anstelle einer konkreten Konfigurations-ID anzugeben, die vom ESP verwendet werden soll.

  2. Speichern Sie die Datei app.yaml.
  3. Da Sie den Abschnitt endpoints_api_service in die Datei app.yaml eingefügt haben, wird der ESP durch den Befehl gcloud app deploy in einem separaten Container in der flexiblen App Engine-Umgebung bereitgestellt und konfiguriert. Sämtliche Trafficanfragen werden über den ESP weitergeleitet. Dieser sendet Anfragen und Antworten zum und vom Container, in dem Ihr Back-End-Servercode ausgeführt wird.

  4. Sie müssen sich im Verzeichnis endpoints/getting-started befinden. Hier befindet sich die Konfigurationsdatei openapi-appengine.yaml.
  5. Führen Sie den folgenden Befehl aus, um die Beispiel-API und den ESP in App Engine bereitzustellen:
  6. Java

    Stellen Sie die API mit Maven bereit:

    mvn appengine:stage
    gcloud app deploy target/appengine-staging
    
    Python
    gcloud app deploy
    Go
    gcloud app deploy
    PHP
    gcloud app deploy
    Ruby
    gcloud app deploy
    NodeJS
    gcloud app deploy

    Mit dem Befehl gcloud app deploy wird ein DNS-Eintrag im Format YOUR_PROJECT_ID.appspot.com erstellt. Sie verwenden diesen Eintrag zum Senden von Anfragen an die API. Warten Sie damit jedoch einige Minuten, damit App Engine die Initialisierung abschließen kann.

Wenn Sie eine Fehlermeldung erhalten, lesen Sie die Informationen unter Fehlerbehebung bei der flexiblen App Engine-Bereitstellung.

Weitere Informationen finden Sie unter API-Back-End bereitstellen.

Anfragen an die API senden

Sobald der Dienst in App Engine ausgeführt wird, können Sie Anfragen senden.

API-Schlüssel erstellen und Umgebungsvariable festlegen

Für den Beispielcode ist ein API-Schlüssel erforderlich. Zur Vereinfachung der Anfrage legen Sie eine Umgebungsvariable für den API-Schlüssel fest.

  1. Erstellen Sie in dem Google Cloud-Projekt, das Sie für Ihre API verwendet haben, auf der Seite mit den API-Anmeldedaten einen API-Schlüssel. Informationen zum Erstellen eines API-Schlüssels in einem anderen Google Cloud-Projekt finden Sie unter API im Google Cloud-Projekt aktivieren.

    Zur Seite "Anmeldedaten"

  2. Klicken Sie auf Anmeldedaten erstellen und wählen Sie anschließend API-Schlüssel aus.
  3. Kopieren Sie den Schlüssel in die Zwischenablage.
  4. Klicken Sie auf Schließen.
  5. Fügen Sie den API-Schlüssel auf Ihrem lokalen Computer ein, um ihn einer Umgebungsvariable zuzuweisen:
    • In Linux oder macOS: export ENDPOINTS_KEY=AIza...
    • In Windows PowerShell: $Env:ENDPOINTS_KEY="AIza..."

Anfrage senden

Linux oder macOS

  1. Erstellen Sie eine Umgebungsvariable für die URL des App Engine-Projekts. Ersetzen Sie YOUR_PROJECT_ID durch die ID Ihres Google Cloud-Projekts.

    export ENDPOINTS_HOST=https://YOUR_PROJECT_ID.appspot.com

  2. Senden Sie eine HTTP-Anfrage mit den Umgebungsvariablen ENDPOINTS_HOST und ENDPOINTS_KEY, die Sie zuvor festgelegt haben:

    curl --request POST \
      --header "content-type:application/json" \
      --data '{"message":"hello world"}' \
      "${ENDPOINTS_HOST}/echo?key=${ENDPOINTS_KEY}"

Im vorherigen Beispiel für curl gilt:

  • Durch die Option --data werden die an die API zu übertragenden Daten festgelegt.
  • Durch die Option --header wird angegeben, dass die Daten im JSON-Format vorliegen.

PowerShell

  1. Erstellen Sie eine Umgebungsvariable für die URL des App Engine-Projekts. Ersetzen Sie YOUR_PROJECT_ID durch die ID Ihres Google Cloud-Projekts.

    $Env:ENDPOINTS_HOST="https://YOUR_PROJECT_ID.appspot.com"

  2. Senden Sie eine HTTP-Anfrage mit den Umgebungsvariablen ENDPOINTS_HOST und ENDPOINTS_KEY, die Sie zuvor festgelegt haben:

    (Invoke-WebRequest -Method POST -Body '{"message": "hello world"}' `
        -Headers @{"content-type"="application/json"} `
        -URI "$Env:ENDPOINTS_HOST/echo?key=$Env:ENDPOINTS_KEY").Content
    

In diesem Beispiel enden die ersten beiden Zeilen mit einem Graviszeichen. Achten Sie beim Einfügen des Beispiels in PowerShell darauf, dass nach dem Graviszeichen kein Leerzeichen folgt. Informationen zu den in der Beispielanfrage verwendeten Optionen finden Sie in der Microsoft-Dokumentation unter Invoke-WebRequest.

Drittanbieteranwendung

Sie können eine Drittanbieteranwendung wie die Chrome-Browsererweiterung Postman zum Senden der Anfrage verwenden:

  • Wählen Sie POST als HTTP-Verb aus.
  • Wählen Sie für den Header den Schlüssel content-type und den Wert application/json aus.
  • Geben Sie als Text Folgendes ein:
    {"message":"hello world"}
  • Verwenden Sie in der URL die tatsächliche appspot.com-Adresse und den API-Schlüssel und nicht die Umgebungsvariablen. Beispiel:
    https://example-project-12345.appspot.com/echo?key=AIza...

Die API gibt die von Ihnen gesendete Meldung zurück und antwortet mit folgender Zeile:

{
  "message": "hello world"
}

Wenn Sie als Antwort einen Fehler erhalten haben, lesen Sie die Informationen unter Fehlerbehebung bei Antwortfehlern.

Sie haben gerade eine API in Cloud Endpoints bereitgestellt und getestet!

API-Aktivität verfolgen

  1. Sehen Sie sich auf der Seite "Endpoints" die Aktivitätsgrafiken für Ihre API an.

    Zur Seite "Endpoints-Dienste"

    Es kann einige Momente dauern, bis die Anfrage in den Grafiken angezeigt wird.

  2. Sehen Sie sich auf der Seite "Loganzeige" die Anfragelogs an.

    Loganzeige aufrufen

Entwicklerportal für die API erstellen

Sie können mit dem Cloud Endpoints-Portal ein Entwicklerportal erstellen. Das ist eine Website zur Interaktion mit der Beispiel-API. Weitere Informationen finden Sie unter Übersicht über das Cloud Endpoints-Portal.

Bereinigen

So vermeiden Sie, dass Ihrem Google Cloud Platform-Konto die in dieser Anleitung verwendeten Ressourcen in Rechnung gestellt werden:

Informationen zum Beenden der in dieser Anleitung verwendeten Dienste finden Sie unter API und API-Instanzen löschen.

Weitere Informationen