Guia de uso da ferramenta

Veja quando usar esta ferramenta, o que ela suporta e como os usuários a aplicam.

Fatos principais

Categoria: Development
Tipos de entrada: text, textarea
Tipo de saída: interactive
Cobertura de exemplos: 4
API pronta: Sim

Visão geral

O GraphQL Playground é um cliente interativo baseado no navegador que permite testar endpoints GraphQL de forma rápida. Com ele, você pode escrever queries e mutations, definir variáveis em formato JSON, configurar cabeçalhos de autenticação e inspecionar instantaneamente as respostas JSON formatadas ou os erros retornados pela API.

Quando usar

Ao desenvolver ou integrar APIs GraphQL e precisar testar queries e mutations rapidamente sem configurar um cliente local.
Para depurar respostas de esquemas GraphQL inspecionando o JSON de retorno ou analisando arrays de erros detalhados.
Quando precisar validar o comportamento de endpoints protegidos enviando cabeçalhos HTTP personalizados e variáveis dinâmicas.

Como funciona

1Insira a URL do endpoint GraphQL no campo correspondente.
2Escreva sua query ou mutation no editor e, se necessário, adicione variáveis no formato JSON e cabeçalhos HTTP.
3Execute a requisição para enviar os dados diretamente ao servidor GraphQL.
4Visualize o resultado formatado em JSON ou a lista de erros retornada pela API no painel de resultados.

Casos de uso

Validação rápida de queries e mutations durante o desenvolvimento de novas funcionalidades em APIs GraphQL.
Teste de payloads e variáveis dinâmicas para simular diferentes cenários de resposta da API.
Depuração de cabeçalhos de segurança e tokens de acesso em endpoints GraphQL protegidos.

Comparar alternativas

Analisa microformats2 (h-entry/h-card), valida Webmention/IndieAuth/Micropub/Microsub, emite visões duais ActivityPub Object+Activity e roteamento reply-all …
Executa uma seleção segura de métodos Lodash sobre JSON.
Solte qualquer arquivo de save — NBT de Minecraft, GVAS de Unreal Engine, contêineres de Palworld, saves de texto JSON/XML/INI/Lua, perfis SQLite — e receba …

Para quem

Ideal para

Converter conteúdo no navegador.
Tarefas repetíveis com conteúdo e as mesmas configurações sempre.
Trabalhos com um resultado como saída.

Pouco adequado para

Trabalhos em lote totalmente automatizados — esta página foi feita para uso interativo; para scripts, use o endpoint da API.
Conteúdo em outros formatos — esta ferramenta espera conteúdo.

Casos extremos e erros frequentes

Arquivos muito grandes
Arquivos grandes demoram mais e podem atingir os limites de memória do navegador — tente primeiro com uma amostra menor.
Ignorar a verificação da saída
Compare as primeiras linhas ou páginas da saída com a entrada antes de usá-la em produção.
Arquivos de exportadores incomuns
Alguns arquivos usam variantes de formato que não convertem de forma limpa — se a saída parecer errada, salve o arquivo novamente no aplicativo que o criou e tente de novo.

Exemplos

1. Consulta de dados geográficos públicos

Desenvolvedor Frontend

Contexto

Um desenvolvedor precisa obter uma lista de continentes e seus respectivos códigos de uma API pública para preencher um componente de seleção no frontend.

Problema

Validar a estrutura da query e o formato do JSON de resposta antes de implementar o código no projeto.

Como usar

Insira o endpoint público no campo correspondente, cole a query de listagem de continentes e execute a requisição.

Endpoint: https://countries.trevorblades.com/
Query:
query {
  continents {
    code
    name
  }
}

Resultado

O painel exibe a lista de continentes formatada em JSON com os campos 'code' e 'name' corretos.

2. Teste de Mutation com Variáveis e Autenticação

Engenheiro de Software

Contexto

Um engenheiro precisa testar a criação de um novo usuário em um ambiente de homologação protegido por token.

Problema

Enviar dados dinâmicos do usuário e garantir que o cabeçalho de autorização seja processado corretamente pela API.

Como usar

Perguntas frequentes

Posso testar endpoints GraphQL locais?

Sim, desde que o endpoint local esteja acessível pelo seu navegador e permita requisições CORS.

Como envio tokens de autenticação nas requisições?

Insira os cabeçalhos necessários no campo 'Cabeçalhos', utilizando o formato padrão como 'Authorization: Bearer seu_token'.

Onde configuro as variáveis da query?

Utilize o campo 'Variáveis (JSON)' para declarar os parâmetros dinâmicos da sua consulta em formato JSON válido.

O que acontece se a query tiver erros de sintaxe?

O playground exibirá os erros detalhados retornados pelo servidor GraphQL diretamente no painel de resultados.

É necessário instalar algum software para usar a ferramenta?

Não, a ferramenta funciona inteiramente no seu navegador de forma online.

Endpoint: https://api.homolog.com/graphql
Headers:
Authorization: Bearer token_de_teste

Query:
mutation CreateUser($input: UserInput!) {
  createUser(input: $input) {
    id
    name
  }
}

Variables:
{
  "input": {
    "name": "João Silva",
    "email": "[email protected]"
  }
}

GraphQL Playground

Executar esta ferramenta

Exemplos compatíveis com esta ferramenta

Continue com ferramentas e temas relacionados

Veja quando usar esta ferramenta, o que ela suporta e como os usuários a aplicam.

Fatos principais

Visão geral

Quando usar

Como funciona

Casos de uso

Comparar alternativas

Para quem

Casos extremos e erros frequentes

Exemplos

1. Consulta de dados geográficos públicos

2. Teste de Mutation com Variáveis e Autenticação

Perguntas frequentes

Coleções Postman - Testes de API

Exemplos Apache Arrow

Exemplos de Rastreamento Distribuído

Exemplos AWS EventBridge

Auditor de dependências do package.json

Visualizador de Plano de Execução SQL

Visualizador de saves de jogos

Utilitário Lodash online