Cloud Endpoints für OpenAPI

Cloud Endpoints ist ein API-Verwaltungssystem, mit dem Sie mit der gleichen Infrastruktur, die Google für seine eigenen APIs nutzt, Ihre APIs schützen, überwachen und analysieren sowie dafür Kontingente festlegen können. Endpoints kann entweder mit Extensible Service Proxy (ESP) und mit Extensible Service Proxy V2 (ESPv2) bereitgestellt werden, um eine API-Verwaltung bereitzustellen. Weitere Informationen über Cloud Endpoints, ESP und ESPv2 finden Sie unter Über Cloud Endpoints.

Cloud Endpoints unterstützt die Version 2 der OpenAPI-Spezifikation (früher Swagger-Spezifikation) – den Branchenstandard für REST APIs. Weitere Informationen über die OpenAPI-Spezifikation finden Sie in der OpenAPI-Übersicht.

In dieser Dokumentation wird erläutert, wie Sie Cloud Endpoints mit OpenAPI verwenden. Weitere Informationen zu den anderen Cloud Endpoints-Optionen finden Sie auf der hier.

Für einen schnellen Einstieg empfehlen wir, die Dokumentation in der folgenden Reihenfolge durchzuarbeiten:

  1. Wenn Sie Cloud Endpoints-Funktionen in Aktion sehen möchten, gehen Sie den Schnellstart für Cloud Endpoints durch. Darin wird mithilfe von Skripts eine Beispiel-API in der flexiblen App Engine-Umgebung bereitgestellt.

  2. Wählen Sie jetzt die Computing-Plattform für die API aus. Eine Entscheidungshilfe finden Sie unter Computing-Option auswählen und im Abschnitt Unterstützte Computing-Plattformen weiter unten.

  3. Nachdem Sie das Backend für Ihre API ausgewählt haben, lesen Sie die spezifische Anleitung für die von Ihnen gewünschte Computing-Plattform.

Unterstützte Computing-Plattformen

Endpoints für OpenAPI hängt entweder vom ESP oder ESPv2 für die API-Verwaltung ab. ESP und ESPv2 sind Open-Source-Projekte. Sie stehen Ihnen unter folgenden Möglichkeiten zur Verfügung:

Sie können den ESP-Container auf den folgenden Plattformen ausführen:

Sie können den ESPv2 Beta-Container auf den folgenden Plattformen ausführen:

  • App Engine
  • Cloud Functions
  • Cloud Run
  • Knative Serving
  • GKE
  • Compute Engine
  • Kubernetes

Weitere Informationen finden Sie unter Über Cloud Endpoints.

In der flexiblen App Engine-Umgebung wird der ESP automatisch bereitgestellt, wenn Sie der Datei app.yaml einige Zeilen hinzufügen. Weitere Informationen finden Sie unter API und ESP bereitstellen. ESPv2 Beta unterstützt die flexible App Engine-Umgebung nicht.

Für die App Engine-Standardumgebung der Generation 1 müssen Sie Endpoints Frameworks verwenden. Wenn Sie den Container stattdessen für eine der oben genannten Computing-Optionen bereitstellen, können Sie einen Proxy für beide Generationen der App Engine-Standardlaufzeit ausführen.