Anleitungen

API konfigurieren und bereitstellen

• Cloud Endpoints konfigurieren

  Erläutert die Vorbereitung eines OpenAPI-Dokuments für die Bereitstellung in Endpoints

• Endpoints-Konfiguration bereitstellen

  Beschreibt das Bereitstellen eines OpenAPI-Dokuments in Endpoints

• API-Back-End bereitstellen

  Erläutert das Bereitstellen des Back-End-Codes einer API und von Extensible Service Proxy (ESP)

• In Kubernetes bereitstellen

  Erläutert das Konfigurieren und Bereitstellen von Endpoints auf Kubernetes

• ESP lokal oder auf einer anderen Plattform ausführen

  Erläutert das Konfigurieren einer Instanz von ESP auf einem lokalen Computer oder einem anderen Cloudanbieter

• Konfigurationsdateien vergleichen

  Beschreibt den Tab Bereitstellungsverlauf auf der Seite Endpunkte > Dienste in der Google Cloud Console und den Vergleich einer bereitgestellten Dienstkonfiguration mit der Vorgängerversion

• Dienstname und Konfigurations-ID abrufen

  Beschreibt das Abrufen des Namens und der Konfigurations-ID eines verwalteten Dienstes

Fehlerbehebung und Monitoring

• Fehlerbehebung – Übersicht

  Enthält allgemeine Informationen zur Fehlerbehebung und Links zu anderen Seiten mit zusätzlichen Informationen

• Fehlerbehebung bei der Bereitstellung von Endpoints-Konfigurationen

  Beschreibt verschiedene Fehler, die beim Bereitstellen einer Endpoints-Konfiguration auftreten können, und bietet Methoden zur Fehlerbehebung

• Fehlerbehebung bei Antwortfehlern

  Beschreibt das Beheben von Fehlern, die als Antwort auf eine Anfrage an Ihre API zurückgegeben werden

• Fehlerbehebung bei der Bereitstellung der flexiblen App Engine-Umgebung

  Erläutert Methoden zur Fehlerbehebung für Endpoints-Bereitstellungen in der flexiblen App Engine-Umgebung

• Fehlerbehebung bei der Compute Engine-Bereitstellung

  Erläutert Methoden zur Fehlerbehebung für Endpoints-Bereitstellungen in Compute Engine

• Fehlerbehebung bei der GKE-Bereitstellung

  Erläutert Methoden zur Fehlerbehebung für Endpoints-Bereitstellungen in GKE

• Fehlerbehebung bei der JWT-Validierung

  Informationen zur Fehlerbehebung, wenn die JWT-Validierung fehlschlägt und ein Fehler in der Antwort an den Client zurückgegeben wird

• API überwachen

  Erläutert das Überwachen des Zustands von eigenen APIs mithilfe der Logs und Messwerte, die Endpoints automatisch erfasst

• API-Tracing

  Erläutert die Trace Sampling-Rate, die Schätzung der Kosten für Cloud Trace, das Aufrufen der Traces in der Google Cloud Console und das Deaktivieren von Trace Sampling.

Cloud Endpoints-Portal

• Übersicht über das Endpoints-Portal

  Bietet eine Übersicht über das Endpoints-Portal und enthält einen Link zur Demo-Website des Endpoints-Portals

• Erste Schritte mit dem Endpoints-Portal

  Beschreibt das Erstellen eines Endpoints-Portals und stellt die Benutzeroberfläche des Endpoints-Portals vor

• SmartDocs aktualisieren

  Beschreibt die Referenzdokumentation der SmartDocs API und wie SmartDocs mithilfe der Felder im OpenAPI-Dokument die API-Dokumentation generiert bzw. wie SmartDocs neu generiert wird

• API testen

  Beschreibt, wie Sie Ihr Portal so konfigurieren, dass Nutzer Ihre API testen können

• Eigene Dokumentation hinzufügen

  Beschreibt, wie Sie die Beispielanleitung "Erste Schritte" ändern und zusätzliche Dokumentationsseiten für Ihr Endpoints-Portal erstellen und anzeigen lassen

• Benutzerdefinierte Dokumentation über eine API synchronisieren

  Beschreibt die Verwendung einer API zum Synchronisieren benutzerdefinierter Dokumentation mit Ihrem Portal

• Benutzerdefinierte Domain einrichten

  Beschreibt, wie Sie das Endpoints-Portal zum Verwenden einer benutzerdefinierten Domain einrichten

DNS und SSL

• Domainnamen prüfen

  Erläutert das Prüfen der Eigentumsrechte eines Domainnamens, mit dem eine Endpoints API bereitgestellt wird

• API über Ihren Domainnamen bereitstellen

  Erläutert das Einrichten des Projekts für die Bereitstellung von API-Anfragen

• DNS in der cloud.goog-Domain konfigurieren

  Erläutert das Konfigurieren des DNS für Endpoints-Dienste, die die Google-Domain cloud.goog verwenden.

• Mehrere APIs über eine Domain bereitstellen

  Erläutert das Ausführen von mehreren unabhängigen APIs auf Ihrer eigenen Domain

• SSL mit ESP aktivieren

  Erläutert das Aktivieren eines SSL-Ports für den bereitgestellten Endpoints-Dienst mit dem ESP

• SSL mit ESPv2 aktivieren

  Erläutert das Aktivieren eines SSL-Ports für Ihren bereitgestellten Endpoints-Dienst mit ESPv2

Authentifizieren und API-Schlüssel

• Authentifizierungsmethode auswählen

  Bietet einen Überblick und Beispiele für Anwendungsfälle zu jeder unterstützten Authentifizierungsmethode

• API-Schlüssel effizient nutzen

  Enthält Hintergrundinformationen zu API-Schlüsseln und deren Verwendung

• Nutzer mit Firebase authentifizieren

  Erläutert, wie Sie Ihr OpenAPI-Dokument so konfigurieren, dass ESP eingehende Anfragen von Clients überprüft, die Firebase zum Authentifizieren von Nutzern verwenden

• Nutzer mit Auth0 authentifizieren

  Erläutert, wie Sie Ihr OpenAPI-Dokument so konfigurieren, dass ESP eingehende Anfragen von Clients überprüft, die Auth0 zum Authentifizieren von Nutzern verwenden

• Nutzer mit Google ID-Tokens authentifizieren

  Erläutert, wie Sie Ihr OpenAPI-Dokument so konfigurieren, dass ESP eingehende Anfragen von Clients überprüft, die Google ID-Tokens zum Authentifizieren von Nutzern verwenden

• Nutzer mit benutzerdefinierten Methoden authentifizieren

  Erläutert, wie Sie Ihr OpenAPI-Dokument so konfigurieren, dass ESP eingehende Anfragen von Clients überprüft, die benutzerdefinierte Anbieter zum Authentifizieren von Nutzern verwenden

• Authentifizierung zwischen Diensten

  Erläutert das Authentifizieren von Dienst-zu-Dienst-Aufrufen

• Zugriff durch API-Schlüssel beschränken

  Erläutert das Verhindern des Zugriffs nicht autorisierter Clientanwendungen und -dienste auf Ihre API

API-Zugriff verwalten

• API-Zugriff – Überblick

  Beschreibt die Zugriffssteuerungsoptionen, die Ihnen in Endpoints zur Verfügung stehen.

• Aktivierung der API steuern

  Erläutert, wie Sie steuern können, wer Ihre API in seinen eigenen Google Cloud-Projekten aktivieren kann

• API im Google Cloud-Projekt aktivieren

  Erläutert das Aktivieren einer API in einem Google Cloud-Projekt.

• Zugriff auf die API gewähren und widerrufen

  Erläutert das Gewähren unterschiedlicher Zugriffsebenen, sodass andere Teammitglieder beim Verwalten der API helfen können

API-Lebenszyklus verwalten

• Überblick über die Verwaltung des API-Lebenszyklus

  Erläutert die Funktionen zur Versionsverwaltung der Endpoints API sowie Best Practices für die Versionsverwaltung und Bereitstellung Ihrer Endpoints API

• API und Instanzen löschen

  Erläutert das Löschen einer API sowie das Herunterfahren von Instanzen, auf denen die API ausgeführt wird, um unnötige Kosten zu vermeiden

• Verwalteten Dienst wiederherstellen

  Erläutert das Wiederherstellen eines verwalteten Dienstes nach versehentlichem Löschen

API-Anfragen begrenzen (Beta)

• Über Kontingente

  Bietet einen Überblick über die wesentliche Funktionalität von Kontingenten

• Kontingente konfigurieren

  Beschreibt das Konfigurieren von Kontingenten für Ihre API

• Limit für das Standardkontingent überschreiben

  Beschreibt das Festlegen eines anderen Kontingentlimits für ein bestimmtes Nutzerprojekt

ESP anpassen

• Benutzerdefinierte nginx.conf in Google Kubernetes Engine verwenden

  Beschreibt, wie Sie eine benutzerdefinierte nginx.conf-Datei zum Bereitstellen des ESP in GKE erstellen

• Benutzerdefinierte nginx.conf zur Unterstützung von CORS erstellen

  Zeigt anhand von Beispielen, wie die ESP-CORS-Optionen in nginx.conf als Ausgangspunkt geschrieben werden, falls Sie die CORS-Unterstützung im ESP anpassen müssen.

Weitere Anleitungen für Endpoints

• Zu ESPv2 migrieren

• Anleitungen für Cloud Endpoints Frameworks für die App Engine-Standardumgebung

• Anleitungen für Cloud Endpoints für gRPC