Nachdem Sie Cloud Endpoints in einem OpenAPI-Dokument konfiguriert haben, stellen Sie es bereit, damit Endpoints über die Informationen verfügt, die zum Verwalten Ihrer API erforderlich sind.
Die Endpoints-Konfiguration wird mit dem Befehl gcloud
endpoints services deploy bereitgestellt. Dieser Befehl verwendet Service Infrastructure, die grundlegende Dienstplattform von Google. Sie wird von Endpoints und anderen Diensten verwendet, um APIs und Dienste zu erstellen und zu verwalten. Auf dieser Seite wird beschrieben, wie Sie ein OpenAPI-Dokument in Endpoints bereitstellen.
Voraussetzungen
Sie sollten Folgendes bereits haben:
Sie haben ein Google Cloud-Projekt erstellt, in dem Sie die Rolle Bearbeiter oder Inhaber haben. Nach der ersten Bereitstellung können Sie einem Nutzer, einer Gruppe oder einem Dienstkonto die restriktivere Rolle des Dienstkonfigurationsbearbeiters erteilen. Weitere Informationen finden Sie unter Zugriff auf die API gewähren und widerrufen.
Wenn Sie einen benutzerdefinierten Domainnamen verwenden (z. B.
my-api.example.com), müssen Sie ihn überprüfen, bevor Sie das OpenAPI-Dokument bereitstellen.
Google Cloud CLI für die Bereitstellung vorbereiten
Verwenden Sie das gcloud-Befehlszeilentool, um die Konfiguration bereitzustellen. Weitere Informationen zu den Befehlen finden Sie in der gcloud-Referenz.
So bereiten Sie die Bereitstellung vor:
- Installieren und initialisieren Sie die gcloud CLI.
- Aktualisieren Sie die gcloud CLI:
gcloud components update
- Achten Sie darauf, dass die gcloud CLI zum Zugriff auf Ihre Daten und Dienste berechtigt ist:
gcloud auth login
Ein neuer Browsertab wird geöffnet und Sie werden aufgefordert, ein Konto auszuwählen.
- Legen Sie das Standardprojekt fest. Ersetzen Sie
[YOUR-PROJECT-ID]durch Ihre GCP-Projekt-ID:gcloud config set project [YOUR-PROJECT-ID]
- Wenn Sie das API-Back-End in Kubernetes oder Kubernetes Engine bereitstellen, führen Sie den folgenden Befehl aus, um neue Nutzeranmeldedaten zur Verwendung als Standardanmeldedaten für Anwendungen abzurufen. Die Nutzeranmeldedaten sind für die Autorisierung von
kubectlerforderlich.gcloud auth application-default login
openapi.json-Syntax wird validiert…
Die OpenAPI-Dokumentdatei kann im YAML- oder JSON-Format vorliegen. Wenn sie im JSON-Format vorliegt, sollten Sie die Syntax vor dem Bereitstellen der Datei überprüfen. Wenn Sie überprüfen möchten, ob die JSON-Datei openapi.json richtig formatiert ist, können Sie sie in einem Texteditor wie vim öffnen, der die Prüfung von JSON unterstützt, oder einen JSONLint-Onlinedienst nutzen. Alternativ können Sie Python verwenden:
python -m json.tool openapi.json
Stellen Sie die JSON-Datei zur besseren Lesbarkeit optimiert dar: