API auf einem Gateway bereitstellen

Auf dieser Seite wird beschrieben, wie Sie eine API in API Gateway bereitstellen.

Vorbereitung

Bevor Sie eine API in API Gateway bereitstellen können, müssen Sie Folgendes tun:

Anforderungen an die Gateway-ID

Bei vielen der in diesem Dokument beschriebenen gcloud CLI-Befehle müssen Sie die ID des Gateways im Format GATEWAY_ID angeben. In API Gateway gelten folgende Anforderungen für die Gateway-ID:

  • Darf maximal 49 Zeichen lang sein.
  • Darf nur Kleinbuchstaben, Ziffern oder Bindestriche enthalten.
  • Er darf nicht mit einem Bindestrich beginnen.
  • Er darf keinen Unterstrich enthalten.

Endpunkt der bereitgestellten API-Konfiguration definieren

Wenn Sie eine API-Konfiguration für ein Gateway bereitstellen, erstellt API Gateway eine eindeutige URL für das Gateway in der Domain gateway.dev. Ihre API-Clients verwenden dann eine URL im folgenden Format, um auf die bereitgestellte API-Konfiguration zuzugreifen:

https://GATEWAY_ID-HASH.REGION_CODE.gateway.dev

Dabei ist GATEWAY_ID der Name des Gateways, HASH der eindeutige Hashcode, der beim Bereitstellen der API generiert wurde, und REGION_CODE ist der Code für den Cloud-Standort, an dem Sie das Gateway bereitgestellt haben.

Beispiel:

https://my-gateway-a12bcd345e67f89g0h.uc.gateway.dev

API auf einem Gateway bereitstellen

So stellen Sie eine API auf einem Gateway bereit:

Google Cloud Console

  1. Rufen Sie in der Google Cloud Console die Seite API Gateway auf.

    Zu API Gateway

  2. Klicken Sie auf Gateway erstellen

    Die Seite Gateway erstellen wird angezeigt.

  3. Wählen Sie unter API auswählen die Option Neue API erstellen aus.
  4. Geben Sie im Feld Anzeigename den Anzeigenamen der API ein.
  5. Geben Sie im Feld API-ID die ID der API ein. Richtlinien zur API-ID
  6. Optional: Fügen Sie Labels für Ihre API hinzu.
  7. Wählen Sie im Abschnitt API-Konfiguration im Feld Konfiguration auswählen die Option Neue API-Konfiguration erstellen aus.
  8. Laden Sie im Feld API-Spezifikation hochladen eine .yaml- oder .json-Datei hoch. Dateiformate für OpenAPI 2.0 und OpenAPI 3.x für die API-Definition
  9. Geben Sie im Feld Anzeigename den Anzeigenamen der API-Konfiguration ein.
  10. Wählen Sie in der Liste Dienstkonto auswählen das gewünschte Dienstkonto aus. Dieses Dienstkonto wird von API Gateway als Identität verwendet.
  11. Optional: Fügen Sie Labels für Ihre API-Konfiguration hinzu.
  12. Geben Sie im Abschnitt Gateway-Details einen Anzeigenamen für das Gateway ein.
  13. Wählen Sie im Feld Standort die Google Cloud Region aus, in der Sie das Gateway bereitstellen möchten.
  14. Optional: Fügen Sie Labels für Ihr API Gateway hinzu.
  15. Klicken Sie auf Gateway erstellen.

    16. Die neu erstellte API ist auf der API Gateway-Startseite sichtbar.

Google Cloud CLI

  1. Überprüfen Sie anhand der Projekt-ID, die vom folgenden Befehl zurückgegeben wurde, ob das Gateway im richtigen Projekt erstellt wird.

    gcloud config list project

    Wenn Sie das Standardprojekt ändern müssen, führen Sie den folgenden Befehl aus und ersetzen Sie PROJECT_ID durch die Google Cloud Projekt-ID , in der Sie den Dienst erstellen möchten:

    gcloud config set project PROJECT_ID

  2. Hier erhalten Sie Hilfe zum Befehl gateway create:

    gcloud api-gateway gateways create --help

  3. Führen Sie den folgenden Befehl aus, um die API-Konfiguration für das Gateway bereitzustellen:

    gcloud api-gateway gateways create GATEWAY_ID \
 --api=API_ID --api-config=CONFIG_ID \
 --location=GCP_REGION

    wobei

    • GATEWAY_ID die ID des neuen Gateways angibt. Wenn das Gateway nicht bereits vorhanden ist, wird es von diesem Befehl erstellt.
    • API_ID die ID der API Gateway API angibt, die mit diesem Gateway verknüpft ist.
    • CONFIG_ID die ID der im Gateway bereitgestellten API-Konfiguration angibt. Beim Erstellen eines Gateways müssen Sie eine API-Konfiguration angeben.
    • GCP_REGION den Cloud-Standort für das bereitgestellte Gateway angibt.

    Beim Erstellen des Gateways gibt die gcloud CLI Informationen an das Terminal aus.

  4. Nach erfolgreichem Abschluss können Sie den folgenden Befehl verwenden, um Details zum Gateway anzuzeigen:

    gcloud api-gateway gateways describe GATEWAY_ID \
 --location=GCP_REGION

    Dieser Befehl gibt Folgendes zurück:

    apiConfig: projects/PROJECT_ID/locations/global/apis/API_ID/configs/CONFIG_ID
createTime: '2020-02-05T13:44:12.997862831Z'
defaultHostname: my-gateway-a12bcd345e67f89g0h.uc.gateway.dev
displayName: GATEWAY_ID
name: projects/PROJECT_ID/locations/GCP_REGION/gateways/GATEWAY_ID
serviceAccount:
 email: gateway-111111@222222-tp.iam.gserviceaccount.com
state: ACTIVE
updateTime: '2020-02-05T13:45:00.844705087Z'

    Beachten Sie den Wert des Attributs defaultHostname. Dies ist der Hostname-Teil der Gateway-URL. Wenn Sie auf eine API-Konfiguration zugreifen möchten, die für dieses Gateway bereitgestellt wurde, verwenden Sie eine URL im folgenden Format:

    https://my-gateway-a12bcd345e67f89g0h.uc.gateway.dev

Die gcloud CLI hat viele Optionen, einschließlich der in der gcloud-Referenz beschriebenen. Darüber hinaus können Sie für API Gateway beim Erstellen eines Gateways die folgenden Optionen festlegen:

  • --async: Gibt die Steuerung sofort an das Terminal zurück, ohne auf den Abschluss des Vorgangs zu warten.
  • --display-name=NAME: Gibt den Anzeigenamen des Gateways an, d. h. den in der Benutzeroberfläche Anzeigenamen. Verwenden Sie keine Leerzeichen im Namen. Verwenden Sie stattdessen Bindestriche und Unterstriche. Der Standardwert ist GATEWAY_ID.
  • --labels=KEY1=VALUE1,KEY2=VALUE2,...: Gibt Labels an, die dem Gateway zugeordnet sind.

Gateways auflisten

In diesem Abschnitt wird beschrieben, wie Sie eine Liste aller in Ihrem Google Cloud Projekt bereitgestellten Gateways aufrufen.

Google Cloud Console

Rufen Sie in der Google Cloud Console die Seite API Gateway > Gateways auf.

Zu Gateways

Google Cloud CLI

So listen Sie Gateways für ein bestimmtes Projekt auf:

gcloud api-gateway gateways list

Dieser Befehl gibt eine Ausgabe im folgenden Format zurück:

GATEWAY_ID        LOCATION       DISPLAY_NAME     STATE     CREATE_TIME          UPDATE_TIME
my-gateway        us-central1    my-gateway       ACTIVE    2021-01-07T00:04:19  2022-05-21T00:33:46

So listen Sie Gateways für ein bestimmtes Projekt und eine bestimmte Region auf:

gcloud api-gateway gateways list --location=GCP_REGION

Verwenden Sie einen filter-Ausdruck, um die Gateways aufzulisten, die mit einer bestimmten API verknüpft sind:

gcloud api-gateway gateways list \
--filter="apiConfig:projects/PROJECT_ID/locations/global/apis/API_ID/*" \

Oder verwenden Sie diesen filter, um Gateways für eine bestimmte API-Konfiguration aufzulisten:

gcloud api-gateway gateways list \
--filter="apiConfig:projects/PROJECT_ID/locations/global/apis/API_ID/configs/CONFIG_ID" \
--project=PROJECT_ID

Verwenden Sie die Regions- und Gateway-IDs, um detaillierte Informationen zum Gateway zu erhalten, einschließlich der Identität der API-Konfiguration, die für das Gateway bereitgestellt wurde:

gcloud api-gateway gateways describe GATEWAY_ID \
--location=GCP_REGION

Gateway aktualisieren

Sie können ein Gateway aktualisieren, um:

  • eine andere API-Konfiguration für das Gateway bereitzustellen
  • den Anzeigenamen zu aktualisieren

  • die Labels zu aktualisieren

Google Cloud Console

Führen Sie die folgenden Schritte aus, um die API Gateway-Details zu aktualisieren:

  1. Rufen Sie in der Google Cloud Console die Seite API Gateway auf.

    Zu API Gateway

  2. Klicken Sie auf die gewünschte API.
  3. Klicken Sie auf den Tab Gateways.
  4. Klicken Sie auf das gewünschte Gateway.
  5. Klicken Sie auf „Bearbeiten“ Bearbeiten.
  6. Bearbeiten Sie den Anzeigenamen oder die Labels.
  7. Wählen Sie die gewünschte API-Konfiguration aus oder klicken Sie auf Neue API-Konfiguration erstellen und erstellen Sie die Konfiguration wie unter API-Konfiguration erstellen beschrieben.
  8. Klicken Sie auf Aktualisieren.
  9. Klicken Sie auf , um zur Seite mit der Gateway-Liste zurückzukehren.
  10. Auf der Seite mit der Gateway-Liste können Sie das aktualisierte Gateway sehen.

Google Cloud CLI

Verwenden Sie den folgenden gcloud CLI-Befehl, um ein vorhandenes Gateway zu aktualisieren. Ersetzen Sie UPDATE_OPTIONS durch das Gateway-Optionsflag und den Wert, den Sie aktualisieren möchten:

gcloud api-gateway gateways update GATEWAY_ID \
UPDATE_OPTIONS --api=API_ID --location=GCP_REGION

Beispiel: So aktualisieren Sie die API-Konfiguration, die für das Gateway bereitgestellt wurde:

gcloud api-gateway gateways update GATEWAY_ID \
--api-config=NEW_CONFIG_ID --api=API_ID --location=GCP_REGION

Dabei gibt NEW_CONFIG_ID die neue API-Konfiguration an, die für das Gateway bereitgestellt werden soll.

Eine vollständige Liste der verfügbaren Update-Flags und -Argumente finden Sie in der Referenz zu gcloud api-gateway gateways update oder verwenden Sie den folgenden Befehl, um alle Update-Optionen aufzurufen:

gcloud api-gateway gateways update --help

Gateway löschen

In diesem Abschnitt wird beschrieben, wie Sie ein vorhandenes API Gateway löschen. Führen Sie diese Schritte aus, um ein Gateway und die zugehörige Konfiguration dauerhaft aus Ihrem Google Cloud Projekt zu entfernen.

Google Cloud Console

  1. Rufen Sie in der Google Cloud Console die Seite API Gateway > Gateways auf.

    Zu Gateways

  2. Klicken Sie auf das Dreipunkt-Menü Mehr und dann auf Lö搅拌 , um das ausgewählte API Gateway zu löschen.

Google Cloud CLI

Verwenden Sie den folgenden gcloud CLI-Befehl, um ein vorhandenes Gateway zu löschen:

gcloud api-gateway gateways delete GATEWAY_ID \
--location=GCP_REGION

Nächste Schritte