Implantar APIs do Cloud Endpoints no gateway de API

O Cloud Endpoints é um sistema de gerenciamento de API que ajuda a proteger, monitorar, analisar e definir cotas de APIs. O Endpoints usa o Extensible Service Proxy (ESP) ou o Extensible Service Proxy V2 (ESPv2) para hospedar suas APIs.

Ao usar o Endpoints, você tem três opções para definir sua API:

Desenvolver APIs com o gateway de API

O Cloud Endpoints e o API Gateway são compatíveis com APIs descritas usando a especificação OpenAPI, OpenAPI 2.0 ou OpenAPI 3.x. Se você usou o OpenAPI para definir suas APIs do Endpoints, isso significa que também é possível implantá-las no gateway de API.

Implantar especificações OpenAPI do Endpoints no gateway de API

A API Gateway é compatível com o mesmo formato e opções de definição de especificação OpenAPI compatíveis com o Cloud Endpoints para OpenAPI. Isso significa que é possível usar as mesmas definições de segurança, cota e outras definições das especificações de OpenAPI do Endpoints para definir uma API no gateway de API.

A única diferença entre o Endpoints e o gateway de API é como eles processam a propriedade host na definição da especificação OpenAPI:

  • No Endpoints, defina a propriedade host como a parte do nome do host do URL criado quando o ESP ou o ESPv2 foi implantado, em que o ESP ou o ESPv2 é o serviço usado para hospedar a API Endpoints.
  • Em Gateway de API, omita a host ou defina-a como o nome DNS da API implantada. Os provedores de API geralmente a definem como o nome DNS ao compartilhar a especificação OpenAPI com os consumidores da API. No entanto, o gateway da API não impõe o valor da propriedade host.

Por exemplo, veja abaixo uma parte de uma definição OpenAPI usada pelo Endpoints para definir uma API para acessar um serviço de back-end implantado em funções do Cloud Run:

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: {}
...

Para saber mais sobre como criar a especificação OpenAPI para a definição da API, consulte a visão geral da OpenAPI.

A seguir