Clientes GraphQL

Esta é uma compilação e uma visão geral de alguns dos clientes mais populares para interagir com GraphQL.

​

GraphiQL

GraphiQL é o IDE por excelência para executar queries GraphQL. Lançado inicialmente junto com o GraphQL, ele tornou imediatamente evidente como o GraphQL poderia oferecer uma experiência de desenvolvimento superior à das APIs existentes, combinando em um único lugar um cliente para executar queries contra o servidor GraphQL e um explorador para navegar pela documentação do schema.

Entre outros recursos, o GraphiQL oferece as seguintes funcionalidades:

• Abas
• Headers personalizados
• Destaque de sintaxe
• Preenchimento automático inteligente de campos, argumentos, tipos e muito mais
• Destaque e relatório de erros em tempo real para queries e variáveis
• Preenchimento automático de queries e variáveis
• Adição automática de campos obrigatórios às queries
• Explorador de documentação, pesquisa, com suporte a Markdown
• Histórico de queries usando armazenamento local
• Temas

Há uma demo disponível em graphql.org/swapi-graphql. Componha uma query GraphQL com a ajuda do editor, pressione o botão "Execute Query" no centro dos dois painéis e veja a resposta à query.

​

Voyager

O GraphQL Voyager é o visualizador interativo de schemas por excelência, mostrando (como mencionado em sua documentação) o "grafo por trás do GraphQL".

Ele vem com estas funcionalidades:

• Navegação rápida no grafo.
• Painel esquerdo que fornece informações mais detalhadas sobre cada tipo.
• Opção "Skip Relay" que simplifica o grafo removendo as classes wrapper do Relay.
• Capacidade de escolher qualquer tipo como raiz do grafo.

Há uma demo ao vivo em ivangoncharov.github.io/graphql-voyager.

​

DociQL

DociQL fornece um comando para gerar uma bela documentação HTML5 estática a partir de um endpoint GraphQL. Após executar o comando, o resultado será um diretório contendo arquivos HTML, CSS e JS que devemos copiar para o nosso servidor web para exibir a documentação do nosso schema GraphQL.

A documentação gerada, por padrão, exibe um layout de página única com 3 colunas, com links para todos os tipos na coluna esquerda, uma descrição no centro e um exemplo de query à direita:

Ele vem com estas funcionalidades:

• Utiliza a introspection query para buscar um schema do GraphQL e gera a documentação dinamicamente.
• Gera um exemplo de requisição e resposta com links "Try it now".
• Permite ao usuário definir casos de uso e agrupá-los por domínio.
• Configurável por meio de templates Handlebars e estilos SCSS.
• Suporte a Markdown nas descrições das APIs.
• Layout responsivo HTML5 e CSS3 que funciona em todos os dispositivos e tamanhos de tela.
• Documentação parcial, incorporável em um site existente.

Há uma demo da documentação gerada disponível em wayfair.github.io/dociql.

​

SpectaQL

SpectaQL se baseia no DociQL para adaptá-lo melhor ao GraphQL. Ele fornece um tema que exibe apenas as informações relevantes para GraphQL, removendo conteúdo do domínio Swagger/OpenAPI (por exemplo, descarta as mensagens "Response Content-Types: application/json" e "Response Example (200 OK)" exibidas no exemplo de query).

O SpectaQL também permite inserir a fonte do schema GraphQL usando várias opções:

• A partir de um endpoint ativo usando a introspection query.
• A partir de um arquivo contendo o resultado de uma introspection query.
• A partir de um arquivo, múltiplos arquivos ou um glob que leva às definições do schema em SDL.

Há uma demo da documentação gerada em useanvil.com/docs/api/graphql/reference.

​

Postman

Postman é uma plataforma de API para criar e usar APIs. Embora não tenha sido criado especificamente para GraphQL, o Postman pode ser usado para executar queries GraphQL e agilizar a colaboração na criação de APIs GraphQL.

O Postman inclui ferramentas que ajudam a acelerar o ciclo de vida das APIs, incluindo design, testes, documentação e mocking das APIs. E podemos organizar as APIs por meio de workspaces para colaborar com membros da equipe distribuídos pelo mundo.

​

Altair

Altair é mais um GraphQL Client IDE, semelhante ao Postman, mas específico para GraphQL.

Além de todos os recursos oferecidos por qualquer GraphQL client IDE, o Altair também oferece ambientes, para que possamos alternar entre o uso de APIs para ambientes local, de staging e de produção, e coleções de queries, para compartilhar facilmente com os membros da equipe.