O Cloud Endpoints é um sistema de gerenciamento de API que ajuda a proteger, monitorar, analisar e definir cotas em APIs usando a mesma infraestrutura do Google para suas próprias APIs. O Endpoints funciona com o Extensible Service Proxy (ESP) e com o Extensible Service Proxy V2 (ESPv2) para fornecer o gerenciamento de APIs. Saiba mais sobre o Endpoints, o ESP e o ESPv2 em Sobre o Endpoints.
O Endpoints é compatível com a versão 2 da especificação OpenAPI (anteriormente conhecida como especificação Swagger), o padrão do setor para definir APIs REST. Se você não estiver familiarizado com a especificação OpenAPI, consulte Visão geral da OpenAPI.
Neste conjunto de documentação, mostramos como usar o Endpoints com a OpenAPI. Para documentação sobre outras opções do Endpoints, consulte Todos os documentos do Endpoints.
Para começar, recomendamos o caminho a seguir:
Para ver os recursos do Endpoints em ação, siga o Guia de início rápido para o Cloud Endpoints, que usa scripts para implantar uma API de exemplo em um ambiente flexível do App Engine.
Agora você precisa decidir qual plataforma de computação quer usar para sua API. Para ajudar você nessa decisão, consulte Como escolher uma opção de computação e a seção Plataformas de computação compatíveis abaixo.
Depois de escolher o back-end para a API, veja o tutorial da plataforma de computação selecionada.
Plataformas de computação compatíveis
O Endpoints para OpenAPI depende do ESP ou do ESPv2 para o gerenciamento de APIs. O ESP e o ESPv2 são projetos de código aberto e estão disponíveis nas seguintes maneiras:
- um contêiner no Google Container Registry
- Consulte as Notas de lançamento do ESP (em inglês) referentes à atual imagem do Docker do ESP.
- Consulte as notas da versão do ESPv2 para ver a imagem atual do Docker do ESPv2.
- código-fonte no GitHub
- Consulte o README do ESP (em inglês) para detalhes sobre como criar o ESP.
- Consulte o README do ESPv2 para detalhes sobre como criar o ESPv2.
É possível executar o contêiner do ESP nos produtos a seguir:
- Ambiente flexível do App Engine
- Google Compute Engine
- Kubernetes, incluindo o Google Kubernetes Engine
- um computador Linux ou macOS ou outra plataforma
É possível executar o contêiner do ESPv2 nestes locais:
- App Engine
- Cloud Functions
- Cloud Run
- Cloud Run for Anthos
- GKE;
- Compute Engine
- Kubernetes
Consulte Sobre o Cloud Endpoints para saber mais.
No ambiente flexível do App Engine, o ESP é implantado automaticamente quando você adiciona algumas linhas ao arquivo app.yaml. Para mais informações, consulte Implantando a API e o ESP. O ESPv2 não é compatível com o ambiente flexível do App Engine.
Para o ambiente padrão da primeira geração do App Engine, você precisa usar o Endpoints Frameworks. Se você, em vez disso, implantar o contêiner em uma das opções de computador acima, será possível fazer proxy para a geração de ambiente de execução padrão do App Engine.