Guias de instruções

Como configurar e implantar uma API

• Como configurar o Cloud Endpoints

  Descrevemos os arquivos de configuração necessários para criar um serviço gRPC gerenciado pelo Endpoints.

• Como implantar a configuração do Endpoints

  Mostramos como implantar uma configuração de serviço no Endpoints.

• Como implantar o back-end da API

  Explicamos como implantar o código de back-end da API e o Extensible Service Proxy (ESP).

• Como executar o ESP localmente ou em outra plataforma

  Explicamos como configurar e executar o ESP em uma máquina local ou em outro provedor de nuvem.

• Como transcodificar HTTP/JSON para gRPC

  Descrevemos como mapear solicitações HTTP/JSON e os respectivos parâmetros para métodos gRPC e os parâmetros e tipos de retorno.

• Como comparar arquivos de configuração

  Descreve a guia Histórico de implantação na página Serviços do Endpoints no console do Google Cloud e como comparar uma configuração de serviço implantada com a versão anterior.

• Como conseguir o nome e a ID de configuração do serviço

  Descrevemos como conseguir o nome e o código de configuração de um serviço gerenciado.

Solução de problemas

• Visão geral sobre a solução de problemas

  Apresentamos informações gerais para a solução de problemas e links de páginas com outras informações.

• Solução de problemas de implantação na configuração do Endpoints

  Descrevemos erros que talvez ocorram na implantação da configuração do Endpoints e como solucioná-los.

• Solução de problemas de erros de respostas

  Descrevemos como solucionar erros recebidos em resposta à solicitação para a API.

• Solução de problemas do Endpoints no Compute Engine

  Fornecemos técnicas de solução de problemas de implantações do Endpoints no Compute Engine.

• Solução de problemas de implantação do GKE

  Fornecemos técnicas de solução de problemas para implantações do Endpoints no GKE.

• Solução de problemas de validação do JWT

  Fornecemos informações sobre solução de problemas em caso de falha de validação do JWT e erro retornado na resposta ao cliente.

• Como monitorar sua API

  Mostra como visualizar as métricas e os registros da API no console do Google Cloud.

• Como rastrear a API

  Explica a taxa de amostragem de traces, como estimar o custo do Cloud Trace, como visualizar os traces no console do Google Cloud e como desativar a amostragem de traces.

Portal do Cloud Endpoints

• Visão geral do portal do Endpoints

  Fornecemos uma visão geral do portal do Endpoints e incluímos um link para o site da demonstração dele.

• Primeiros passos para usar o portal do Endpoints

  Descreve como criar um portal do Endpoints e apresenta a interface do usuário.

• Como atualizar SmartDocs

  Descreve a documentação de referência da API SmartDocs, como o SmartDocs usa as partes dos arquivos de configuração de serviço e .proto para gerar a documentação da API e como gerar novamente os SmartDocs.

• Como testar a API

  Descrevemos como configurar seu portal para que os usuários possam testar a API.

• Como sincronizar a documentação personalizada por meio de uma API

  Descreve como usar uma API para sincronizar a documentação personalizada com o seu portal.

• Como configurar um domínio personalizado

  Descrevemos como configurar o portal do Endpoints para usar um domínio personalizado.

DNS e SSL

• Como verificar o nome de domínio

  Mostramos como verificar a propriedade de um nome de domínio que disponibiliza uma API do Endpoints.

• Como disponibilizar uma API do nome de domínio

  Mostramos como configurar seu projeto para atender às solicitações da API.

• Como configurar o DNS no domínio cloud.goog

  Mostra como configurar o DNS para serviços do Endpoints que usam o domínio cloud.goog, que é de propriedade do Google e gerenciado por ele.

• Como disponibilizar várias APIs de um domínio

  Mostramos como executar diversas APIs independentes no próprio domínio.

• Como ativar o SSL com o ESP

  Mostra como ativar uma porta SSL para o serviço do Endpoints implantado usando o ESP.

• Como ativar o SSL com o ESPv2

  Mostra como ativar uma porta SSL para o serviço do Endpoints implantado usando o ESPv2.

Chaves de autenticação e de API

• Como escolher um método de autenticação

  Apresentamos uma visão geral e amostras de casos de uso de cada método de autenticação compatível.

• Por que e quando usar chaves de API

  Apresentamos informações de referência sobre autenticação e chaves de API, além de cenários em que é preciso levar em conta o uso dessas chaves.

• Como autenticar usuários

  Mostramos como configurar a autenticação para uma API gRPC.

• Autenticação entre serviços

  Mostramos como usar a autenticação entre serviços em um serviço gRPC.

• Como restringir o acesso à API com as chaves de API

  Descrevemos como restringir acesso aos clientes que têm uma chave de API.

Como gerenciar acesso à API

• Visão geral do acesso à API

  Descrevemos as opções de controle de acesso à API disponíveis no Endpoints.

• Como controlar quem pode ativar a API

  Mostra como controlar quem pode ativar a API nos próprios projetos do Google Cloud.

• Como ativar uma API no projeto do Google Cloud

  Mostra como ativar uma API em um projeto do Google Cloud.

• Como conceder e revogar o acesso à API

  Mostramos como conceder diferentes níveis de acesso para que outros membros da equipe gerenciem a API.

Gerenciamento do ciclo de vida da API

• Como planejar seus projetos do Google Cloud

  Fornece recomendações para convenções de nomenclatura dos projetos do Google Cloud que talvez você precise criar além do projeto do Google Cloud para o back-end de produção.

• Como excluir uma API e instâncias

  Mostramos como excluir uma API e encerrar instâncias que executam a API para evitar custos desnecessários.

• Como restaurar um serviço gerenciado

  Mostra como restaurar um serviço gerenciado em caso de exclusão acidental.

Como limitar solicitações de API (Beta)

• Sobre cotas

  Apresenta uma visão geral sobre a funcionalidade essencial fornecida pelas cotas.

• Como configurar cotas

  Descreve como configurar cotas para uma API.

• Como modificar o limite de cota padrão

  Descrevemos como configurar um limite diferente de cotas para um determinado projeto de consumidor.

Como personalizar o ESP

• Como usar um nginx.conf personalizado no Google Kubernetes Engine

  Descreve como criar um arquivo nginx.conf personalizado para implantar o ESP no GKE.

• Como criar um nginx.conf personalizado compatível com CORS

  Mostra exemplos de como as opções do CORS do ESP são gravadas em nginx.conf como ponto de partida, caso seja necessário personalizar o suporte ao CORS no ESP.

Outros guias de instruções do Endpoints

• Migrar para o ESPv2

• Guias de instruções do Cloud Endpoints Frameworks para o ambiente padrão do App Engine

• Guias de instruções do Cloud Endpoints para OpenAPI