Sobre a API do GraphQL

A API do GraphQL de GitHub oferece flexibilidade e a capacidade de definir precisamente os dados que você deseja buscar.

Visão Geral

Aqui estão alguns links rápidos para ajudá-lo colocar em funcionamento a API v4 do GraphQL:

Sobre o GraphQL

A linguagem de consulta de dados do GraphQL é:

  • Uma especificação. A especificação determina a validade do esquema no servidor da API. O esquema determina a validade das chamadas dos clientes.

  • Linguagem inflexível. O esquema define o sistema de tipos de uma API e todas as relações de objetos.

  • Introspectivo. Um cliente pode consultar o esquema para obter informações sobre o esquema.

  • Hierárquico. A forma de uma chamada do GraphQL espelha a forma dos dados do JSON que ela retorna. Os Campos aninhados permitem que você consulte e receba apenas os dados que você especificar em uma única transação.

  • Uma camada do aplicativo O GraphQL não é um modelo de armazenamento ou um linguagem de consulta de banco de dados. O gráfico refere-se a estruturas gráficas definidas no esquema, em que nós definem os objetos e bordas definem as relações entre os objetos. A API percorre e retorna dados do aplicativo com base nas definições do esquema, independentemente de como os dados são armazenados.

Por que o GitHub está usando GraphQL

O GitHub escolheu o GraphQL para a nossa API v4 porque ele oferece muito mais flexibilidade para os nossos integradores. A capacidade de definir precisamente os dados que você deseja—e apenas os dados que você quer—é uma vantagem poderosa dos pontos de extremidades da API REST v3. O GraphQL permite que você substitua várias solicitações de REST por uma única chamada para buscar os dados que você especificar.

Para obter mais informações sobre por que o GitHub fez a migração para o GraphQL, consulte o post de anúncio do blogue original.

Sobre a referência do esquema do GraphQL

A documentação na barra lateral é gerada a partir do esquema de do GraphQL de GitHub. Todas as chamadas são validadas e executadas contra o esquema. Use estes documentos para descobrir quais dados você pode chamar:

Você pode acessar esse mesmo conteúdo através da Barra lateral de documentos do Explorador. Observe que você pode precisar confiar tanto na documentação quanto na validação do esquema para chamar com sucesso a API do GraphQL.

Para obter outras informações, como detalhes de autenticação e limite de taxa, confira os guias.

Solicitar suporte

For questions, bug reports, and discussions about Aplicativos do GitHub, Aplicativos OAuth, and API development, explore the Fórum de Suporte e Desenvolvimento de API GitHub. O fórum é moderado e mantido por funcionários de GitHub, mas as dúvidas postadas no fórum não têm garantia de recebimento de resposta por parte dos funcionários de GitHub.

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

  • resposta garantida dos funcionários de GitHub Enterprise Server
  • solicitações de suporte que envolvem dados confidenciais ou questões privadas
  • solicitações de recursos
  • feedback sobre produtos de GitHub Enterprise Server

Esse documento ajudou você?

Política de Privacidade

Ajude-nos a tornar esses documentos ótimos!

Todos os documentos do GitHub são de código aberto. Você percebeu que algo que está errado ou não está claro? Envie um pull request.

Faça uma contribuição

Ou, aprenda como contribuir.