Sobre o Cloud Endpoints

O Endpoints é um sistema de gerenciamento de APIs distribuído. Ele oferece console de APIs, hospedagem, geração de registros, monitoramento e outros recursos para ajudar você a criar, compartilhar, manter e proteger suas APIs. Nesta página, você terá uma visão geral do Cloud Endpoints para OpenAPI. Para mais informações sobre outros tipos de frameworks de API compatíveis com o Endpoints, consulte toda a documentação do Endpoints.

O Endpoints usa o Extensible Service Proxy (ESP) distribuído para oferecer baixa latência e alto desempenho, assim atendendo até as APIs mais exigentes. O ESP é um proxy de serviço baseado em NGINX (em inglês). Isso garante o escalonamento conforme as necessidades do usuário para processar solicitações simultâneas à API. O ESP é executado no próprio contêiner do Docker para oferecer melhor isolamento e escalonabilidade, além de ser distribuído no Container Registry. É possível usá-lo com o ambiente flexível do App Engine, o Google Kubernetes Engine (GKE), o Compute Engine ou o Kubernetes.

Arquitetura do Endpoints

O Endpoints usa o Service Infrastructure para gerenciar APIs e gerar relatórios de registros e métricas. A maioria das APIs do Google Cloud usa essa mesma infraestrutura. É possível gerenciar e monitorar as APIs na página Serviços do Endpoint no Console do Google Cloud.

Hospedar uma API

O Cloud Endpoints é otimizado para o ambiente de contêiner do Docker. É possível hospedar sua API em qualquer lugar em que o Docker seja compatível, desde que tenha acesso de Internet ao Google Cloud.

No entanto, o Cloud Endpoints oferece um fluxo de trabalho otimizado para a execução das APIs nestes locais:

  • Compute Engine
  • GKE
  • ambiente flexível do App Engine, que inclui ESP integrado.

Como desenvolver uma API REST com o Endpoints para OpenAPI

O Endpoints não depende de linguagens. Você desenvolve a API em qualquer linguagem e framework REST compatível com a descrição dela usando um arquivo de configuração do OpenAPI.

Para usar o Endpoints para OpenAPI, você precisa:

  • Configurar o Endpoints: descreva a superfície da API e configure os recursos do Endpoints, como chaves de API ou regras de autenticação, em um arquivo de configuração da OpenAPI.

  • implantar a configuração do Endpoints: depois de definir a API no arquivo de configuração do OpenAPI, use o SDK do Cloud para implantá-la no Service Management. Ele é usado pelo Endpoints para gerenciar a API. Agora, o Endpoints sabe todas as informações sobre sua API e como protegê-la;

  • Implantar o back-end da API : implante o ESP e o back-end da API em um back-end compatível do Google Cloud, como o Compute Engine. O ESP coordena com os serviços de back-end do Endpoints para proteger e monitorar a API no ambiente de execução.

Controlar o acesso à API

Com o Endpoints, é possível configurar a API para exigir uma chave de API nas chamadas e validá-la. Também é possível usar o Console do Google Cloud para compartilhar a API com outros desenvolvedores. Assim, eles podem ativar sua API e gerar chaves para chamá-la.

Autenticar usuários da API

Na maioria das chamadas de API, há um usuário na outra extremidade. As chaves de API indicam o app que faz uma chamada para sua API, e o processo de autenticação identifica o usuário que está utilizando esse app.

Seu servidor de API ainda precisa definir o que o usuário autenticado pode fazer com a API. Para mais informações, consulte o guia de autenticação do Google Cloud.

A seguir

  • Para se familiarizar com as etapas de implantação e ver como os recursos do Endpoints funcionam, execute o Guia de início rápido do Cloud Endpoints, que usa scripts para implantar uma API de amostra em um back-end flexível do App Engine.

  • Para saber mais sobre como usar o Endpoints, acesse os tutoriais.