API erstellen

Auf dieser Seite wird beschrieben, wie Sie eine API erstellen.

Vorbereitung

Bevor Sie eine API erstellen können, müssen Sie Folgendes tun:

Anforderungen an die API-ID

Bei vielen der unten aufgeführten gcloud-Befehle müssen Sie die ID der API im folgenden Format angeben: API_ID. In API Gateway gelten folgende Anforderungen für die API-ID:

  • Muss eine maximale Länge von 63 Zeichen haben.
  • Darf nur Kleinbuchstaben, Ziffern oder Bindestriche enthalten.
  • Er darf nicht mit einem Bindestrich beginnen.
  • Er darf keinen Unterstrich enthalten.

API erstellen

eine API erstellen

Google Cloud Console

Erstellen und stellen Sie eine API bereit, wie unter API auf einem Gateway bereitstellen beschrieben.

Google Cloud CLI

In den folgenden Abschnitten finden Sie Informationen zum Erstellen einer API:

Schritte zum Erstellen einer API

  1. Überprüfen Sie anhand der Projekt-ID, die vom folgenden Befehl zurückgegeben wurde, ob der Dienst 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

    Wenn die Projekt-ID einen Doppelpunkt (:) enthält, finden Sie unter Auf Domains beschränkte Projekte weitere Informationen zum Erstellen einer API in Ihrem Projekt.

  2. Hier erhalten Sie Hilfe zum Befehl apis create:

    gcloud api-gateway apis create --help

  3. Führen Sie den folgenden Befehl aus, um die API zu erstellen:

    gcloud api-gateway apis create API_ID

    wobei

    Beim Erstellen der API gibt API Gateway Informationen an das Terminal aus.

  4. Nach erfolgreichem Abschluss können Sie den folgenden Befehl verwenden, um Details zur neuen API aufzurufen:

    gcloud api-gateway apis describe API_ID

    Dieser Befehl gibt Folgendes zurück:

          createTime: '2020-02-29T21:52:20.297426875Z'
      displayName: API_ID
      managedService: MANAGED_SERVICE_NAME.apigateway.PROJECT_ID.cloud.goog
      name: projects/PROJECT_ID/locations/global/apis/API_ID
      state: ACTIVE
      updateTime: '2020-02-29T21:52:20.647923711Z'

Google Cloud CLI-Optionen

Die Google Cloud CLI hat viele Optionen, einschließlich der in der gcloud-Referenz beschriebenen. Darüber hinaus können Sie für API Gateway beim Erstellen einer API 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 der API an, d. h. den in der Benutzeroberfläche angezeigten Namen. Verwenden Sie keine Leerzeichen im Namen. Verwenden Sie stattdessen Bindestriche und Unterstriche. Der Standardwert ist API_ID.
  • --labels=KEY1=VALUE1,KEY2=VALUE2,...: Gibt Labels an, die der API-Konfiguration zugeordnet sind.
  • --managed-service: Gibt einen bereits verwalteten Dienst für die API an. Weitere Informationen finden Sie unter Auf Domains beschränkte Projekte.

Auf Domains beschränkte Projekte

Wenn Ihr Projekt auf eine Domain beschränkt ist, umfasst die Projekt-ID den Namen der Domain mit einem Doppelpunkt (:), z. B. example.com:my-project. Sie müssen einen gültigen verwalteten Dienst angeben, wenn Sie eine API in einem Projekt mit Bereichsangabe erstellen.

Wenn Sie gcloud verwenden, geben Sie den Namen des verwalteten Dienstes mit dem Flag --managed-service an, wie unter Google Cloud CLI-Optionen beschrieben.

APIs auflisten

Alle APIs in einem Projekt auflisten

Google Cloud Console

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

Zu API Gateway

Google Cloud CLI

gcloud api-gateway apis list

Dieser Befehl gibt die Ausgabe in folgendem Format zurück:

  NAME                                              DISPLAY_NAME  MANAGED_SERVICE                          STATE
  projects/PROJECT_ID/locations/global/apis/API_ID  API_ID        MANAGED_SERVICE_NAME.apigateway.PROJECT_ID.cloud.goog  ACTIVE

Verwenden Sie die API-ID, um detaillierte Informationen zur API zu erhalten:

gcloud api-gateway apis describe API_ID

API aktualisieren

Nach der Erstellung können Sie die Labels und den Anzeigenamen einer vorhandenen API aktualisieren.

Google Cloud Console

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

    Zu API Gateway

  2. Klicken Sie auf die erforderliche API.
  3. Klicken Sie auf den Tab Details.
  4. Klicken Sie auf Bearbeiten Bearbeiten.
  5. Bearbeiten Sie Anzeigename oder Labels und klicken Sie dann auf Speichern.

Google Cloud CLI

Verwenden Sie die folgenden gcloud-Optionen, um eine vorhandene API zu aktualisieren:

  • --display-name
  • --update-labels
  • --clear-labels
  • --remove-labels

Beispiel:

  gcloud api-gateway apis update API_ID \
    --update-labels=a=1,b=2

Verwenden Sie den folgenden Befehl, um alle Aktualisierungsoptionen aufzurufen:

gcloud api-gateway apis update --help

API löschen

So löschen Sie eine API:

  • Löschen Sie die API-Gateways, die mit der API und ihren API-Konfigurationen verknüpft sind.
  • Löschen Sie die mit der API verknüpften API-Konfigurationen.
  • Löschen Sie die API:

Google Cloud Console

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

    Zu API Gateway

  2. Klicken Sie auf die API, die Sie löschen möchten.
  3. Klicken Sie auf den Tab Konfigurationen.
  4. Wählen Sie die API-Konfiguration(en) aus und klicken Sie auf Mehr und dann auf Löschen.
  5. Klicken Sie auf , um zur Startseite von API Gateway zurückzukehren.
  6. Klicken Sie auf das Dreipunkt-Menü und dann auf Löschen, um die ausgewählte API zu löschen.

Google Cloud CLI

  1. Ermitteln Sie die Liste der mit der API verknüpften API Gateways:

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

  2. Löschen Sie alle mit der API verknüpften API-Konfigurationen:

    gcloud api-gateway api-configs delete CONFIG_ID --api=API_ID

  3. Löschen Sie die API:

    gcloud api-gateway apis delete API_ID

Nächste Schritte