Cloud Endpoints pour OpenAPI

Cloud Endpoints est un système de gestion d'API qui vous aide à sécuriser, surveiller, analyser et définir des quotas sur les API en utilisant la même infrastructure que celle utilisée par Google pour ses propres API. Endpoints assure la gestion des API à l'aide d'Extensible Service Proxy (ESP) et d'Extensible Service Proxy V2 bêta (ESPv2 bêta). Pour en savoir plus sur Endpoints, ESP et ESPv2 bêta, consultez la page À propos de Endpoints.

Endpoints est compatible avec la version 2 de la spécification OpenAPI (précédemment connue sous le nom de spécification Swagger), le standard du secteur pour la définition des API REST. Si vous ne connaissez pas la spécification OpenAPI, reportez-vous à la section Présentation d'OpenAPI.

Cet ensemble de documentations explique comment utiliser Endpoints avec OpenAPI. Pour plus d'informations sur les autres options d'Endpoints, consultez l'ensemble des documents Endpoints.

Pour commencer, nous vous recommandons de consulter la documentation dans l'ordre suivant :

  1. Pour voir les fonctionnalités Cloud Endpoints en action, suivez le guide de démarrage rapide de Cloud Endpoints, qui utilise des scripts pour déployer un exemple d'API dans l'environnement flexible App Engine.

  2. Vous devez maintenant choisir quelle plate-forme de calcul vous souhaitez utiliser pour votre API. Pour vous aider dans cette décision, vous pouvez consulter la page Choisir une option de calcul et la section Plates-formes de calcul compatibles ci-dessous.

  3. Une fois que vous avez choisi le backend de votre API, suivez le tutoriel de votre plate-forme de calcul préférée.

Plates-formes de calcul compatibles

Endpoints pour OpenAPI repose sur ESP ou ESPv2 bêta pour la gestion des API. ESP et ESPv2 bêta sont des projets Open Source qui vous sont proposés comme suit :

  • Un conteneur dans Google Container Registry.
  • Le code source dans GitHub.
    • Consultez le fichier ESP README pour obtenir plus de détails sur la création d'ESP.
    • Consultez le fichier ESP README pour obtenir plus de détails sur la création d'ESP.

Vous pouvez exécuter le conteneur ESP sur les éléments suivants :

Vous pouvez exécuter le conteneur ESPv2 bêta sur les éléments suivants :

  • App Engine
  • Cloud Functions
  • Cloud Run
  • Cloud Run pour Anthos
  • GKE
  • Instance
  • Kubernetes

Ces fonctionnalités sont actuellement en version bêta. Consultez la section À propos de Cloud Endpoints pour plus d'informations.

Dans l'environnement flexible App Engine, ESP est automatiquement déployé lorsque vous ajoutez quelques lignes au fichier app.yaml. Pour plus d'informations, consultez la section Déployer l'API et ESP. ESPv2 bêta n'est pas compatible avec l'environnement flexible App Engine.

Pour l'environnement standard App Engine de génération 1, vous devez utiliser Endpoints Frameworks. Si vous déployez plutôt le conteneur selon l'une des options de calcul ci-dessus, vous pouvez utiliser un proxy pour l'une ou l'autre génération de l'environnement d'exécution standard App Engine.