Diese Seite wurde von der Cloud Translation API übersetzt.

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 Architekturübersicht zu Cloud Endpoints.

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.

Richten Sie ein Google Cloud Platform-Projekt ein, installieren Sie die erforderliche Software und erstellen Sie eine App Engine-Anwendung. Siehe Vorbereitung.
Beispielcode herunterladen: Siehe Beispielcode abrufen.
Konfigurieren Sie die Datei openapi-appengine.yaml, mit der Endpoints konfiguriert wird. Siehe Endpoints konfigurieren.
Die Endpoints-Konfiguration bereitstellen, um einen Endpoints-Dienst zu erstellen. Siehe Endpoints-Konfiguration bereitstellen.
Die API und den ESP in App Engine bereitstellen. Siehe API-Backend bereitstellen.
Eine Anfrage an die API senden. Siehe Anfrage an die API senden.
API-Aktivitäten verfolgen. Siehe API-Aktivitäten verfolgen.
Vermeiden Sie Gebühren, die Ihrem Google Cloud-Konto in Rechnung gestellt werden. Siehe Bereinigen.

Kosten

In diesem Dokument verwenden Sie die folgenden kostenpflichtigen Komponenten von Google Cloud:

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 der in diesem Dokument beschriebenen Aufgaben können Sie weitere Kosten vermeiden, indem Sie die erstellten Ressourcen löschen. Weitere Informationen finden Sie unter Bereinigen.

Hinweise

Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Go to project selector

Make sure that billing is enabled for your Google Cloud project.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Go to project selector

Make sure that billing is enabled for your Google Cloud project.

Notieren Sie sich die Projekt-ID, da sie später benötigt wird.
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.
Laden Sie die Google Cloud CLI herunter.
Aktualisieren Sie die gcloud CLI und installieren Sie die Endpoints-Komponenten.
```
gcloud components update
```
Die Google Cloud CLI (gcloud) muss für den Zugriff auf Ihre Daten und Dienste auf Google Cloud berechtigt sein:
```
gcloud auth login
```
Ein neuer Browsertab wird geöffnet. Wählen Sie dort ein Konto aus.
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 gcloud CLI-Konfigurationen verwalten.
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
```
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 klonen Sie die Beispiel-API oder laden diese herunter:

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.
Klonen Sie das Repository der Beispiel-App 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.
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:

Klonen Sie das Repository der Beispiel-App 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.
Wechseln Sie zu dem Verzeichnis, das den Beispielcode enthält:
```
cd python-docs-samples/endpoints/getting-started
```

So klonen Sie die Beispiel-API oder laden diese herunter:

Prüfen Sie, ob die Umgebungsvariable GOPATH festgelegt ist.

Klonen Sie das Repository der Beispielanwendung auf Ihren lokalen Computer:

go get -d github.com/GoogleCloudPlatform/golang-samples/endpoints/getting-started

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:

Klonen Sie das Repository der Beispiel-App 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.
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:

Klonen Sie das Repository der Beispiel-App 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.
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:

Klonen Sie das Repository der Beispiel-App 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.
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:

Öffnen Sie im Beispielcodeverzeichnis die Konfigurationsdatei openapi-appengine.yaml.

Java

swagger: "2.0"
info:
  description: "A simple Google Cloud Endpoints API example."
  title: "Endpoints Example"
  version: "1.0.0"
host: "YOUR-PROJECT-ID.appspot.com"

Python

swagger: "2.0"
info:
  description: "A simple Google Cloud Endpoints API example."
  title: "Endpoints Example"
  version: "1.0.0"
host: "YOUR-PROJECT-ID.appspot.com"

swagger: "2.0"
info:
  description: "A simple Google Cloud Endpoints API example."
  title: "Endpoints Example"
  version: "1.0.0"
host: "YOUR-PROJECT-ID.appspot.com"

PHP

swagger: "2.0"
info:
  description: "A simple Google Cloud Endpoints API example."
  title: "Endpoints Example"
  version: "1.0.0"
host: "YOUR-PROJECT-ID.appspot.com"

Ruby

swagger: "2.0"
info:
  description: "A simple Google Cloud Endpoints API example."
  title: "Endpoints Example"
  version: "1.0.0"
host: "YOUR-PROJECT-ID.appspot.com"

NodeJS

swagger: "2.0"
info:
  description: "A simple Google Cloud Endpoints API example."
  title: "Endpoints Example"
  version: "1.0.0"
host: "YOUR-PROJECT-ID.appspot.com"

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.

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-Backend 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 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:

Sie müssen sich im Verzeichnis endpoints/getting-started befinden.
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 Google Cloud Console auf der Seite Endpoints > Dienste aufrufen.

Wenn Sie eine Fehlermeldung erhalten, lesen Sie Fehlerbehebung bei der Endpoints-Konfigurationsbereitstellung.

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

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

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-Backend 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:

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