Guides d'utilisation

Configurer et déployer une API

• Configurer Cloud Endpoints

  Cette page explique comment préparer le document OpenAPI avant de le déployer sur Endpoints.

• Déployer la configuration Endpoints

  Cette page décrit comment déployer un document OpenAPI sur Endpoints.

• Déployer le backend de l'API

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

• Déployer sur Kubernetes

  Cette page explique comment configurer et déployer Endpoints sur Kubernetes.

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

  Cette page explique comment configurer une instance du proxy ESP sur un ordinateur local ou sur un autre fournisseur cloud.

• Comparer des fichiers de configuration

  Cette page décrit l'onglet Historique de déploiement de la page Points de terminaison > Services de 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

  Cette page décrit comment obtenir le nom et l'ID de configuration d'un service géré.

Dépannage et surveillance

• 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 des problèmes concernant le déploiement dans l'environnement flexible App Engine

  Cette page présente des techniques de dépannage pour les déploiements Endpoints dans l'environnement flexible App Engine.

• Résoudre des problèmes de déploiement 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 relatives aux déploiements Endpoints sur GKE.

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

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

• Surveiller une API

  Cette page décrit comment surveiller l'état des API à l'aide des journaux et des métriques que Endpoints conserve automatiquement.

• 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.

• Premiers pas avec le portail Endpoints

  Cette page explique 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, comment SmartDocs utilise les champs du document OpenAPI pour générer la documentation de l'API et comment régénérer les SmartDocs.

• Essayer l'API

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

• Ajouter de la documentation personnalisée

  Cette page explique comment modifier l'exemple du guide de démarrage et comment créer et afficher des pages de documentation supplémentaires pour le portail Endpoints.

• 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.

• Diffuser 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 Cloud 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 leur utilisation.

• Utiliser Firebase pour authentifier les utilisateurs

  Cette page explique comment configurer le document OpenAPI de sorte que ESP valide les requêtes entrantes des clients utilisant Firebase pour authentifier les utilisateurs.

• Utiliser Auth0 pour authentifier les utilisateurs

  Cette page explique comment configurer le document OpenAPI de sorte que ESP valide les requêtes entrantes des clients utilisant Auth0 pour authentifier les utilisateurs.

• Utiliser des jetons d'ID Google pour authentifier les utilisateurs

  Cette page explique comment configurer le document OpenAPI de sorte que ESP valide les requêtes entrantes des clients utilisant des jetons d'ID Google pour authentifier les utilisateurs.

• Utiliser une méthode personnalisée pour authentifier les utilisateurs

  Cette page explique comment configurer le document OpenAPI de sorte que ESP valide les requêtes entrantes des clients utilisant un fournisseur personnalisé pour authentifier les utilisateurs.

• S'authentifier entre différents services

  Cette page explique comment authentifier les appels entre plusieurs services.

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

  Cette page montre comment empêcher l'accès à l'API aux applications et services clients non autorisés.

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

• Présentation de la gestion du cycle de vie des API

  Cette page décrit les fonctionnalités de gestion des versions pour les API Endpoints et présente les bonnes pratiques relatives à la gestion des versions et à la préproduction des API Endpoints.

• 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 gRPC