Übersicht über das Cloud Endpoints-Portal

Sie haben die Möglichkeit, mit dem Cloud Endpoints-Portal ein Entwicklerportal zu erstellen, also eine Website, auf der Nutzer sich mit Ihrer Cloud Endpoints API vertraut machen und sie testen können. Entwickler, die Ihre API in ihrem eigenen Code verwenden, erhalten auf diesem Portal die von der SmartDocs API erstellte Referenzdokumentation. SmartDocs verwendet Ihre gRPC-Dienstkonfiguration, um eine API-Referenzdokumentation zu generieren. Im Bereich API testen von SmartDocs haben Entwickler die Möglichkeit, mit Ihrer API zu interagieren, ohne die Dokumentation zu verlassen.

Portal

Sie können auch eine eigene Dokumentation bereitstellen, um Nutzern den Einstieg in die API und deren erfolgreiche Verwendung zu erleichtern.

Besuchen und erkunden Sie die Demoversion des Endpoints-Portals, die aus verschiedenen Endpoints-Beispielen erstellt wurde.

Beschränkungen

  1. Nutzer müssen sich mit einem GCP-Projekt authentifizieren, um auf das Entwicklerportal zugreifen zu können. Nicht authentifizierte Nutzer können das Entwicklerportal nicht sehen.
  2. Der Endpoints-Dienst muss öffentlich zugänglich sein, damit der Bereich API testen verwendet werden kann. Anfragen schlagen fehl, wenn andere Authentifizierung wie IAP auf dem Endpoints-Dienst konfiguriert wird.
  3. Das Endpoints-Portal unterstützt keine identisch benannten Nachrichten oder Dienste, die in separaten Namespaces einer einzelnen Endpoints-Bereitstellung deklariert sind. Dies kann Nutzer betreffen, die sich an die Best Practices für die Versionsverwaltung der API mit Endpoints halten. Verwenden Sie einen der folgenden Ansätze, um eine falsche Versionsverwaltung für Nachrichten oder Dienste zu vermeiden:
    • Benenne alle Nachrichten und Dienste in allen .proto-Dateien eindeutig. Nennen Sie die data-Nachricht beispielsweise in Version 1 data1, data2 in Version 2 usw.
    • Teilen Sie die API-Versionen in verschiedene Endpoints-Bereitstellungen.

Nächste Schritte