Visão geral

O APIs Explorer do Google é uma ferramenta disponível na maioria das páginas de documentação de métodos da API REST que permite testar os métodos das APIs do Google sem escrever código. O APIs Explorer age em dados reais, portanto, tenha cuidado ao testar métodos que criam, modificam ou excluem dados.

Usar o diretório

Para ver uma lista de APIs do Google que você pode explorar, consulte o Diretório de APIs do Google Explorer. Esta lista contém links para a documentação de referência da API para APIs compatíveis. Siga as etapas abaixo para conhecer a API:

  1. Abra o Diretório de APIs do Google Explorer.
  2. Na caixa de pesquisa, na parte superior, digite o nome da API que você quer explorar.
  3. Clique no nome da API. A documentação de referência da API será aberta.
  4. À esquerda, clique no método que você quer usar na navegação.
  5. À direita, encontre o painel "quot;Testar este método". Veja abaixo detalhes sobre como usar o painel lateral do APIs Explorer e como expandi-lo para o painel do APIs Explorer em tela cheia.

Usar o painel lateral

Painel lateral do APIs Explorer para a API Google Books
Figura 1: painel lateral do APIs Explorer para a API Google Books.

Por padrão, o APIs Explorer aparece no lado direito da tela na documentação de referência da API para métodos compatíveis.

Você pode personalizar e interagir com as seguintes seções no painel lateral do APIs Explorer:

  • Parâmetros de solicitação, se obrigatórios pelo método.
  • Corpo da solicitação, se exigido pelo método.
  • Credentials, para testar o método com vários tipos e escopos de credenciais.
  • Botão Execute para executar o método usando os parâmetros e configurações que você especificou.
  • Resultado, exibido somente após a execução do método.

Usar o painel em tela cheia

Painel de tela cheia do APIs Explorer para a API Google Books
Figura 2: painel em tela cheia do APIs Explorer para a API Google Books.

No painel lateral recolhido das APIs Explorer, clique em de tela cheia para expandir o APIs Explorer. O painel em tela cheia exibe um painel extra que contém amostras de código, respostas application/json e respostas HTTP brutas.

Autenticação

O APIs Explorer usa as próprias credenciais para fazer uma solicitação. Não é possível usar credenciais personalizadas com o APIs Explorer.

Formatos de dados

O APIs Explorer só é compatível com JSON de respostas e payloads de solicitação. Mesmo que sua API seja compatível com outros formatos de dados, esses formatos não funcionam no APIs Explorer.

Próximas etapas