Déployer des API Cloud Endpoints sur API Gateway

Cloud Endpoints est un système de gestion d'API qui vous aide à sécuriser, surveiller, analyser et définir des quotas sur vos API. Endpoints utilise Extensible Service Proxy (ESP) ou Extensible Service Proxy V2 (ESPv2) pour héberger vos API.

Lorsque vous utilisez Endpoints, vous disposez de trois options pour définir votre API :

Développer des API avec API Gateway

Endpoints et API Gateway sont compatibles avec les API décrites à l'aide de la spécification OpenAPI, OpenAPI 2.0 ou OpenAPI 3.x. Si vous avez utilisé OpenAPI pour définir vos API Endpoints, cela signifie que vous pouvez également déployer vos API Endpoints sur API Gateway.

Déployer des spécifications OpenAPI Endpoints sur API Gateway

API Gateway est compatible avec le même format et les mêmes options de définition de spécification OpenAPI que Cloud Endpoints pour OpenAPI. Cela signifie que vous pouvez utiliser les mêmes définitions de sécurité, de quota et autres de vos spécifications OpenAPI Endpoints pour définir une API dans API Gateway.

La seule différence entre Endpoints et API Gateway réside dans la façon dont ils traitent la propriété host dans la définition de spécification OpenAPI :

  • Dans Endpoints, définissez la propriété host sur la partie nom d'hôte de l'URL créée lorsque vous avez déployé ESP ou ESPv2, où ESP ou ESPv2 est le service utilisé pour héberger votre API Endpoints.
  • Dans API Gateway, omettez host ou définissez-le sur le nom DNS de l'API déployée. Les fournisseurs d'API le définissent souvent sur le nom DNS lorsqu'ils partagent la spécification OpenAPI avec leurs utilisateurs d'API. Toutefois, API Gateway n'applique pas la valeur de la propriété host.

Par exemple, voici une partie d'une définition OpenAPI utilisée par Endpoints pour définir une API afin d'accéder à un service de backend déployé sur Cloud Run Functions :

OpenAPI 2.0

swagger: '2.0'
info:
  title: Cloud Endpoints + GCF
  description: Sample API on Cloud Endpoints with a Google Cloud Functions backend
  version: 1.0.0
host: HOST
schemes:
  - https
  ...

OpenAPI 3.x

openapi: 3.0.4
info:
  title: Cloud Endpoints + GCF
  description: Sample API on Cloud Endpoints with a Google Cloud Functions backend
  version: 1.0.0
servers:
- url: https://HOST
  x-google-endpoint: {}
...

Pour en savoir plus sur la création de la spécification OpenAPI pour votre définition d'API, consultez la présentation d'OpenAPI.

Étape suivante