Présentation du portail Cloud Endpoints

Vous pouvez utiliser le portail Cloud Endpoints pour créer un portail des développeurs, c'est-à-dire un site Web auquel les utilisateurs de votre API Cloud Endpoints peuvent accéder pour explorer et tester votre API. Dans votre portail, les développeurs qui utilisent votre API dans leur propre code peuvent trouver la documentation de référence de l'API SmartDocs. SmartDocs se base sur votre document OpenAPI pour générer une documentation de référence sur l'API. SmartDocs comprend une section Essayer cette API afin que les développeurs puissent interagir avec votre API sans quitter la documentation.

portail

Vous pouvez également fournir votre propre documentation pour aider les utilisateurs à exploiter votre API.

Consultez la démonstration du portail Endpoints pour découvrir plusieurs exemples de portails créés avec Endpoints.

Limites

  1. Les utilisateurs doivent s'authentifier auprès d'un projet GCP pour accéder au portail des développeurs. Les utilisateurs non authentifiés ne peuvent pas afficher le portail des développeurs.
  2. Le service Endpoints doit être accessible au public pour utiliser le panneau Essayer cette API. Les requêtes échouent si une autre authentification (telle que IAP) est configurée sur le service Endpoints.
  3. Le portail Endpoints n'est pas compatible avec les messages ou services portant un nom identique et déclarés dans des espaces de noms distincts pour un même déploiement Endpoints. Cela peut affecter les utilisateurs qui tentent de suivre les bonnes pratiques de gestion des versions de l'API avec Endpoints. Pour éviter une gestion incorrecte des versions de messages ou de services, utilisez l'une des méthodes suivantes :
    • Attribuez un nom unique à tous les messages et services de tous les fichiers .proto. Par exemple, nommez le message data "data1" dans la version 1, "data2" dans la version 2, etc.
    • Séparez les versions d'API en différents déploiements Endpoints.

Étape suivante