Como usar clientes do GraphQL

Como usar IDEs de cliente do GraphQL

Há muitos IDEs de cliente do GraphQL de código aberto que você pode usar para acessar a API do GraphQL do GitHub.

Consulte AUTOTITLE para obter informações abrangentes sobre métodos HTTP, autenticação e a estrutura de chamadas do GraphQL.

Primeiro, escolha um cliente. As opções comuns incluem GraphiQL, Insomnia e Altair (desktop/web/extensão). Você pode ver a lista completa de clientes no diretório de ferramentas da organização do GraphQL.

As instruções gerais a seguir funcionarão com a maioria dos clientes do GraphQL:

1. Aponte o cliente para o ponto de extremidade do GraphQL: https://api.github.com/graphql.

2. Adicione um cabeçalho Authorization: Authorization: Bearer TOKEN (substitua TOKEN pelo arquivo personal access token do GitHub. Para obter mais informações, confira: Gerenciar seus tokens de acesso pessoal).

3. Defina o método de solicitação POST como ou se ele estiver disponível, use o modo GraphQL fornecido pelo cliente.

4. Insira sua consulta ou mutação no editor e, se necessário, forneça variáveis no painel "Variáveis".

   Exemplo:

   query {
     viewer {
       login
     }
   }
   

5. Se o cliente precisar de um esquema para renderização de documentação ou preenchimento automático, busque-o por meio de uma consulta de introspecção do GraphQL. Muitos clientes podem fazer isso automaticamente no painel "Documentação".

   Consulta de introspecção mínima:

   query IntrospectionQuery {
     __schema {
       types {
         name
       }
     }
   }
   

6. Execute a solicitação e inspecione a resposta JSON. A consulta do exemplo deve retornar o logon associado ao personal access token do GitHub com os quais você se autenticou.

Use a interface do usuário do cliente para explorar documentos, executar consultas e salvar solicitações conforme necessário.

GitHub CLI

Você também pode usar a linha de comando com a GitHub CLI para executar consultas do GraphQL.

1. Instale e autentique na GitHub CLI.
2. Execute uma consulta no https://api.github.com/graphql usando o ponto de extremidade do GraphQL com o subcomando gh api.

Exemplo:

gh api graphql -f query='query { viewer { login } }'

Ela deve retornar o logon associado ao personal access token do GitHub com os quais você se autenticou.

Solicitar suporte

Em caso de dúvidas, relatórios de bug e discussões sobre o GitHub Apps, o OAuth apps e o desenvolvimento de API, explore o Categoria de API e Webhooks nas Discussões da Comunidade do GitHub. As discussões são moderadas e mantidas pela equipe GitHub e respondidas pela comunidade GitHub.

Considere a possibilidade de entrar em contato diretamente com o Suporte do GitHub usando o formulário de contato para:

• Resposta garantida da equipe do GitHub
• Solicitações de suporte que envolvem dados confidenciais ou questões privadas
• Solicitações de recursos
• Comentários sobre os produtos do GitHub