Primeiros passos com o gateway de API e o App Engine

Nesta página, mostramos como configurar um gateway de API para gerenciar e proteger um serviço de back-end do App Engine.

Lista de tarefas

Ao seguir o tutorial, use a lista de tarefas abaixo. Todas as tarefas são necessárias para implantar um gateway de API para seu serviço de back-end do App Engine.

1. Crie ou selecione um projeto do Google Cloud .
2. Se você não implantou seu próprio App Engine, implante um aplicativo de amostra. Consulte Antes de começar.
3. Ative os serviços de gateway de API obrigatórios.
4. Configure o IAP para proteger seu aplicativo. Consulte Configurar o IAP.
5. Crie uma descrição do OpenAPI que descreva sua API e configure as rotas para seu App Engine. Consulte Criar uma configuração de API.
6. Implante um gateway de API usando a configuração de API. Consulte Como implantar um gateway de API.
7. Rastreie as atividades nos aplicativos. Consulte Como rastrear a atividade da API.
8. Para evitar cobranças na sua conta do Google Cloud . Consulte Limpeza.

Antes de começar

1. No console do Google Cloud , acesse a página Painel e selecione ou crie um projeto do Google Cloud .

   Ir para a página "Painel"

2. Verifique se o faturamento foi ativado para o projeto.

   Ativar faturamento

3. Anote o ID do projeto que você quer usar neste tutorial. No restante desta página, esse ID de projeto é chamado de PROJECT_ID.

4. Faça o download e instale a Google Cloud CLI.

   Fazer o download da CLI gcloud

5. Atualize os componentesgcloud:

   gcloud components update

6. Defina o projeto padrão. Substitua PROJECT_ID pelo ID do projeto Google Cloud :

   gcloud config set project PROJECT_ID

7. Se você não tiver implantado seu próprio aplicativo do App Engine, siga as etapas no Guia de início rápido do App Engine para que sua linguagem use a Google Cloud CLI a fim de selecionar ou criar um projeto Google Cloud e implantar um app de exemplo. Anote o URL do aplicativo, bem como a região e o ID do projeto em que ele está implantado.

Ativar serviços obrigatórios

O gateway de API exige que você ative os seguintes serviços Google Cloud :

Para ativar os serviços necessários:

gcloud services enable apigateway.googleapis.com
gcloud services enable servicemanagement.googleapis.com
gcloud services enable servicecontrol.googleapis.com

Configurar o IAP para proteger o aplicativo

Para proteger seu aplicativo do App Engine, você precisa usar o Identity Aware Proxy (IAP) para verificar se as solicitações são autenticadas. Esse processo inclui especificar os membros que precisam receber o papel IAP-secured Web App User necessário para o projeto.

Siga as etapas para Ativar o IAP e verifique se você consegue fazer login no seu aplicativo.

Criar uma configuração de API

Antes de usar o gateway de API para gerenciar o tráfego para o back-end implantado do App Engine, ele precisa de uma configuração de API.

Você pode criar uma configuração de API usando uma descrição OpenAPI que contenha anotações especializadas para definir o comportamento escolhido do gateway de API. É necessário adicionar um campo específico do Google que contenha o URL de cada aplicativo do App Engine para que o gateway de API tenha as informações necessárias para invocar um aplicativo.

Para mais detalhes sobre as extensões da OpenAPI compatíveis, consulte o seguinte:

• Extensões OpenAPI 2.0 no gateway de API
• Extensões OpenAPI 3.x da OpenAPI no gateway de API

Para criar a configuração da API:

1. Crie um arquivo de texto chamado openapi-appengine.yaml. Por conveniência, esta página se refere à descrição da OpenAPI por esse nome de arquivo, mas você pode nomear algo diferente, se preferir.
2. Copie o conteúdo do arquivo a seguir no seu arquivo openapi-run.yaml:

   OpenAPI 2.0

   # openapi-appengine.yaml
   swagger: '2.0'
   info:
     title: API_ID optional-string
     description: Sample API on API Gateway with an App Engine backend
     version: 1.0.0
   schemes:
     - https
   produces:
     - application/json
   paths:
     /hello:
       get: