Guides d'utilisation

Configurer et déployer une API

• Configurer Cloud Endpoints

  Cette page décrit les fichiers de configuration nécessaires à la création d'un service gRPC géré par Endpoints.

• Déployer la configuration Endpoints

  Cette page montre comment déployer une configuration de service sur Endpoints.

• Déployer le backend de l'API

  Cette page explique comment déployer le code de backend de l'API et Extensible Service Proxy (ESP).

• Exécuter ESP en local ou sur une autre plate-forme

  Cette page explique comment configurer et exécuter ESP sur une machine locale ou sur un autre fournisseur cloud.

• Transcoder du contenu HTTP/JSON en gRPC

  Cette page montre comment faire correspondre les requêtes HTTP/JSON et leurs paramètres aux méthodes gRPC, ainsi qu'à leurs paramètres et à leurs types de renvoi.

• Comparer des fichiers de configuration

  Cette page décrit l'onglet Historique de déploiement de la page Services Endpoints dans la console Google Cloud et explique comment comparer une configuration de service déployée avec la version précédente.

• Obtenir le nom du service et l'ID de configuration

  Décrit comment obtenir le nom et l'identifiant de configuration d'un service géré.

Dépannage

• Présentation de la section de dépannage

  Cette page fournit des informations générales de dépannage et des liens vers d'autres pages pour obtenir des informations supplémentaires.

• Résoudre des problèmes de déploiement de la configuration Endpoints

  Cette page décrit des erreurs que vous pouvez rencontrer lors du déploiement de la configuration de Endpoints et fournit des informations permettant de les résoudre.

• Résoudre des problèmes concernant les erreurs de réponse

  Cette page explique comment résoudre les erreurs que vous recevez dans une réponse de requête adressée à l'API.

• Résoudre les problèmes liés à Cloud Endpoints sur Compute Engine

  Cette page présente des techniques de dépannage pour les déploiements Endpoints sur Compute Engine.

• Résoudre des problèmes de déploiement sur GKE

  Cette page présente des techniques de dépannage pour les déploiements Endpoints sur GKE.

• Résoudre des problèmes de validation de jetons JWT

  Cette page fournit des informations de dépannage en cas d'échec de validation JWT et de renvoi d'erreur dans la réponse au client.

• Surveiller une API

  Explique comment afficher les métriques et les journaux de l'API dans la console Google Cloud.

• Tracer une API

  Cette page explique le taux d'échantillonnage de traces, comment estimer vos coûts pour Cloud Trace, comment afficher les traces dans la console Google Cloud et comment désactiver l'échantillonnage de traces.

Portail Cloud Endpoints

• Présentation du portail Endpoints

  Cette page présente le portail Endpoints et inclut un lien vers le site Web de démonstration de ce dernier.

• Familiarisez-vous avec le portail Endpoints.

  Cette page décrit comment créer un portail Endpoints et présente l'interface utilisateur du portail Endpoints.

• Mettre à jour des SmartDocs

  Cette page décrit la documentation de référence de l'API SmartDocs, la manière dont SmartDocs utilise les parties de vos fichiers .proto et de vos fichiers de configuration du service pour générer la documentation de l'API, et la méthode permettant de régénérer des SmartDocs.

• Essayez l'API

  Cette page décrit comment configurer le portail afin que les utilisateurs puissent tester votre API.

• Synchroniser la documentation personnalisée via une API

  Cette page décrit comment utiliser une API pour synchroniser une documentation personnalisée sur votre portail.

• Configurer un domaine personnalisé

  Cette page décrit comment configurer le portail Endpoints pour utiliser un domaine personnalisé.

DNS et SSL

• Valider un nom de domaine

  Cette page montre comment valider la propriété d'un nom de domaine permettant de diffuser une API Endpoints.

• Publier une API à partir d'un nom de domaine

  Cette page montre comment configurer votre projet de manière à publier des requêtes API.

• Configurer un DNS sur le domaine cloud.goog

  Cette page explique comment configurer le DNS pour les services Endpoints qui utilisent le domaine cloud.goog, que Google détient et gère.

• Publier plusieurs API à partir d'un domaine

  Cette page explique comment exécuter plusieurs API indépendantes sur votre propre domaine.

• Activer SSL avec ESP

  Cette page explique comment activer un port SSL pour le service Endpoints déployé à l'aide d'ESP.

• Activer SSL avec ESPv2

  Cette page explique comment activer un port SSL pour le service Endpoints déployé à l'aide d'ESPv2.

Authentification et clés API

• Choisir une méthode d'authentification

  Cette page offre un aperçu et des exemples de cas d'utilisation pour chaque méthode d'authentification compatible.

• Quand et pourquoi utiliser les clés API

  Cette page fournit des informations générales sur les clés API et sur l'authentification, ainsi que sur les situations dans lesquelles vous pouvez envisager d'utiliser les clés API.

• Authentifier les utilisateurs

  Cette page explique comment configurer l'authentification pour une API gRPC.

• S'authentifier entre différents services

  Cette page explique comment utiliser l'authentification entre plusieurs services dans un service gRPC.

• Restreindre l'accès à l'API avec des clés API

  Cette page explique comment restreindre l'accès à une API aux seuls clients disposant de la clé API correspondante.

Gérer l'accès aux API

• Présentation de l'accès aux API

  Cette page décrit les options de contrôle d'accès aux API disponibles dans Endpoints.

• Contrôler qui peut activer votre API

  Cette page explique comment contrôler les utilisateurs autorisés à activer votre API dans leurs propres projets Google Cloud.

• Activer une API dans votre projet Google Cloud

  Cette page explique comment activer une API dans un projet Google Cloud.

• Accorder et révoquer l'accès à l'API

  Cette page explique comment accorder différents niveaux d'accès afin que les autres membres de l'équipe puissent contribuer à la gestion de l'API.

Gérer le cycle de vie des API

• Planifier vos projets Google Cloud

  Cette page fournit des recommandations sur les conventions de dénomination des projets Google Cloud que vous devrez peut-être créer en plus du projet Google Cloud pour votre backend de production.

• Supprimer une API et des instances

  Cette page explique comment supprimer une API et arrêter les instances qui l'exécutent pour éviter des coûts inutiles.

• Restaurer un service géré

  Cette page explique comment restaurer un service géré en cas de suppression accidentelle.

Limiter les requêtes API (bêta)

• À propos des quotas

  Cette page fournit une vue d'ensemble de la fonctionnalité clé fournie par les quotas.

• Configurer les quotas

  Cette page décrit comment configurer des quotas pour votre API.

• Ignorer la limite de quota par défaut

  Cette page décrit comment définir une limite de quota différente pour un projet client spécifique.

Personnaliser le proxy ESP

• Utiliser un fichier nginx.conf personnalisé sur Google Kubernetes Engine

  Cette page explique comment créer un fichier nginx.conf personnalisé pour déployer ESP sur GKE.

• Créer un fichier nginx.conf personnalisé compatible avec le CORS

  Cette page présente des exemples de la manière dont les options CORS d'ESP sont écrites dans nginx.conf, comme point de départ, au cas où vous auriez besoin de personnaliser la compatibilité du CORS avec ESP.

Autres guides pratiques sur Endpoints

• Migrer vers ESPv2

• Guides pratiques sur Cloud Endpoints Frameworks pour l'environnement standard App Engine

• Guides pratiques sur Cloud Endpoints pour OpenAPI