Usar o API Explorer

Nesta página, você aprende a usar o API Explorer para testar os métodos da API Dataproc metastore. O API Explorer é um widget anexado à página de referência da API REST de um método. Ele aparece como um painel com o título Testar esta API.

O API Explorer é uma excelente maneira de testar métodos na API Monitoring sem precisar escrever nenhum código. O widget apresenta um formulário que mostra os parâmetros de cada método. Preencha o formulário, clique no botão Executar e veja os resultados.

Também é possível ocultar o widget clicando no botão "Fechar" na parte superior do painel ou expandi-lo para tela cheia clicando no botão "Tela cheia".

Antes de começar

Como acessar o API Explorer

O API Explorer é anexado à página de referência de cada método da API REST. Para encontrar o widget, acesse a página de referência de um método, por exemplo, a página de referência do metastore do Dataproc projects.locations.services.create.

Como executar uma solicitação mínima

A maioria dos métodos tem alguns parâmetros obrigatórios e outros opcionais. Os obrigatórios são marcados com uma barra vermelha até serem preenchidos. É possível executar uma solicitação mínima fornecendo apenas os argumentos necessários.

O método services.create cria um serviço Metastore do Dataproc em um projeto e local escolhidos. Os campos obrigatórios são os campos parent e serviceId. Para criar um serviço, forneça o número do projeto e o código do local do pai usando o formulário projects/{projectNumber}/locations/{locationId}. E forneça o ID do serviço para serviceId.

Faça o teste!

Os resultados da invocação do método aparecem em uma caixa abaixo do botão Executar. Normalmente, a caixa tem um cabeçalho verde com o código de status HTTP 200, indicando que a solicitação foi bem-sucedida.

Se o cabeçalho estiver vermelho e contiver um código de falha HTTP, a caixa conterá a mensagem de erro. Consulte Dicas para ver algumas dicas sobre como resolver erros.

Como fornecer parâmetros adicionais

A lista de parâmetros que você vê depende do método ao qual o widget do API Explorer está anexado. O método services.create tem mais do que apenas os parâmetros parent e serviceId, mas eles são os únicos parâmetros obrigatórios.

Use o parâmetro opcional requestId para especificar um código de solicitação exclusivo para permitir que o servidor ignore a solicitação se ela for concluída.

Como usar campos para limitar ainda mais a saída

Por padrão, o conjunto de parâmetros que o API Explorer mostra corresponde aos parâmetros do método associado. No entanto, o widget do API Explorer também tem um conjunto de campos adicionais que não estão disponíveis por meio do próprio método.

Esses parâmetros ficam ocultos na opção Exibir parâmetros padrão.

Clique nesse botão para expor os parâmetros adicionais do widget. Clique em Ocultar parâmetros padrão para ocultá-los.

O mais útil desses parâmetros padrão é o parâmetro fields, que permite selecionar os campos na saída retornada que você quer ver. Isso é muito útil no painel do API Explorer, em que a saída é exibida em uma caixa. Geralmente, há muitas saídas para percorrer.

Dicas

Lembre-se de alterar {projectNumber} and {locationId}

Não se esqueça de substituir {projectNumber} and {locationId} pelo número do projeto e pelo ID do local. Observe que a API também aceita o ID do projeto no lugar do número.

Problemas com os valores

Veja alguns problemas a serem observados ao usar os formulários do API Explorer. Esses erros podem causar erros ou ser aceitos, mas são tratados como erros de ortografia no método da API:

  • Não use aspas em valores de campo de qualquer tipo.
  • Não se esqueça de usar aspas nas strings que aparecem dentro de filtros. Use aspas duplas (") e não apóstrofos (').
  • Não use barras invertidas ou codificação de URL em campos de formulário. Se necessário, a codificação de URL é executada nos valores de campo quando você executa o método.
  • Observe o valor na caixa de resultado depois de executar a chamada. É possível notar o problema lá.
  • Convém fornecer um valor para o campo pageSize, como 2. Isso limita a quantidade de dados retornados à medida que você depura sua chamada de API.

Adicione URLs aos favoritos para depuração

Depois de receber a saída que você quer, adicione o URL do API Explorer aos favoritos. Para executar o método novamente, cole o URL no navegador. Você verá o formulário já preenchido com seus valores. Faça as alterações necessárias nos parâmetros e clique em Executar para executar o método novamente.

Authentication

Há uma seção de Autenticação na página do API Explorer, acima do botão Executar. Normalmente, não é necessário alterar nada aqui.

O mecanismo de autenticação padrão é Google OAuth 2.0.

Há também um botão Mostrar escopos na seção Autenticação. Isso mostra quais escopos do Compute Engine estão disponíveis. Por padrão, todos os escopos disponíveis estão ativados.

A seguir