Cloud Endpoints APIs in API Gateway bereitstellen

Cloud Endpoints ist ein API-Verwaltungssystem, mit dem Sie Ihre APIs schützen, überwachen, analysieren und Kontingente dafür festlegen können. Endpoints verwendet den Extensible Service Proxy (ESP) oder Extensible Service Proxy V2 (ESPv2) zum Hosten Ihrer APIs.

Wenn Sie Endpoints verwenden, haben Sie drei Möglichkeiten, Ihre API zu definieren:

APIs mit API Gateway entwickeln

Sowohl Endpoints als auch API Gateway unterstützen APIs, die mit der OpenAPI-Spezifikation OpenAPI 2.0 oder OpenAPI 3.x beschrieben werden. Wenn Sie OpenAPI zum Definieren Ihrer Endpoints-APIs verwendet haben, können Sie Ihre Endpoints-APIs auch in API Gateway bereitstellen.

OpenAPI-Spezifikationen für Endpoints in API Gateway bereitstellen

API Gateway unterstützt dasselbe OpenAPI-Spezifikationsdefinitionsformat und dieselben Optionen wie Cloud Endpoints for OpenAPI. Das bedeutet, dass Sie dieselben Sicherheits-, Kontingent- und anderen Definitionen aus Ihren Endpoints-OpenAPI-Spezifikationen verwenden können, um eine API in API Gateway zu definieren.

Der einzige Unterschied zwischen Endpoints und API Gateway besteht darin, wie die host-Eigenschaft in der OpenAPI-Spezifikationsdefinition verarbeitet wird:

  • Legen Sie in Endpoints die Eigenschaft host auf den Hostnamen-Teil der URL fest, die beim Bereitstellen von ESP oder ESPv2 erstellt wurde. ESP oder ESPv2 ist der Dienst, der zum Hosten Ihrer Endpoints API verwendet wird.
  • In API Gateway: Lassen Sie host weg oder legen Sie es auf den DNS-Namen der bereitgestellten API fest. API-Anbieter legen sie häufig auf den DNS-Namen fest, wenn sie die OpenAPI-Spezifikation für ihre API-Nutzer freigeben. API Gateway erzwingt jedoch nicht den Wert der Eigenschaft host.

Das Folgende ist beispielsweise ein Teil einer OpenAPI-Definition, die von Endpoints verwendet wird, um eine API für den Zugriff auf einen Backend-Dienst zu definieren, der in Cloud Run-Funktionen bereitgestellt wird:

OpenAPI 2.0

swagger: '2.0'
info:
  title: Cloud Endpoints + GCF
  description: Sample API on Cloud Endpoints with a Google Cloud Functions backend
  version: 1.0.0
host: HOST
schemes:
  - https
  ...

OpenAPI 3.x

openapi: 3.0.4
info:
  title: Cloud Endpoints + GCF
  description: Sample API on Cloud Endpoints with a Google Cloud Functions backend
  version: 1.0.0
servers:
- url: https://HOST
  x-google-endpoint: {}
...

Weitere Informationen zum Erstellen der OpenAPI-Spezifikation für Ihre API-Definition finden Sie unter OpenAPI-Übersicht.

Nächste Schritte