API erstellen
Vorbereitung
Bevor Sie eine API in API Gateway erstellen können, müssen folgende Voraussetzungen erfüllt sein:
- Bereiten Sie die Entwicklungsumgebung wie unter Entwicklungsumgebung konfigurieren beschrieben vor.
Anforderungen an API-IDs
Viele der unten aufgeführten gcloud
-Befehle erfordern die Angabe der ID der API im folgenden Format: API_ID.
Für API Gateway gelten die folgenden 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
So erstellen Sie eine API:
Ü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 ID des Google Cloud-Projekts, in dem 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.Hier erhalten Sie Hilfe zum Befehl
apis create
:gcloud api-gateway apis create --help
Führen Sie den folgenden Befehl aus, um die API zu erstellen:
gcloud api-gateway apis create API_ID --project=PROJECT_ID
wobei
- API_ID die ID der neuen API angibt. Richtlinien zur API-ID
- PROJECT_ID gibt die Google Cloud-Projekt-ID an.
Beim Erstellen der API gibt API Gateway Informationen an das Terminal aus.
Nach erfolgreichem Abschluss können Sie den folgenden Befehl verwenden, um Details zur neuen API aufzurufen:
gcloud api-gateway apis describe API_ID --project=PROJECT_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'
gcloud-Optionen
Die Google Cloud CLI hat viele Optionen, einschließlich der in der gcloud-Referenz beschriebenen. Außerdem für API Gateway können Sie 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 Namen, der auf der Benutzeroberfläche angezeigt wird. 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, z. B. einen vorhandenen Endpoints-Dienst.
Auf Domains beschränkte Projekte
Wenn Ihr Projekt auf Ihre Domain beschränkt ist, enthält die Projekt-ID den Namen
Die Domain gefolgt von einem Doppelpunkt (:
), z. B. example.com:my-project
. Ich
muss beim Erstellen einer API auf Domainebene einen gültigen verwalteten Dienst bereitstellen
Projekt arbeiten.
Wenn Sie gcloud
verwenden, geben Sie den Namen des verwalteten Dienstes mit dem Flag --managed-service
an, wie in den gcloud-Optionen beschrieben.
APIs auflisten
So listen Sie alle APIs in einem Projekt auf:
gcloud api-gateway apis list --project=PROJECT_ID
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 Projekt-ID und die API-ID, um detaillierte Informationen zur API zu erhalten:
gcloud api-gateway apis describe API_ID --project=PROJECT_ID
API aktualisieren
Nach dem Erstellen können Sie die Labels und den Anzeigenamen einer vorhandenen API aktualisieren.
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 --project=PROJECT_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 mit der API verknüpften API-Konfigurationen.
- Löschen Sie die API:
So löschen Sie eine API:
Liste der mit der API verknüpften API-Konfigurationen ermitteln:
gcloud api-gateway api-configs list --api=API_ID --project=PROJECT_ID
Löschen Sie alle mit der API verknüpften API-Konfigurationen:
gcloud api-gateway api-configs delete CONFIG_ID --api=API_ID --project=PROJECT_ID
Löschen Sie die API:
gcloud api-gateway apis delete API_ID --project=PROJECT_ID