Skip to main content
Publicamos atualizações frequentes em nossa documentação, e a tradução desta página ainda pode estar em andamento. Para obter as informações mais atualizadas, acesse a documentação em inglês.

Esta versão do GitHub Enterprise será descontinuada em 2023-03-15. Nenhum lançamento de patch será feito, mesmo para questões críticas de segurança. Para obter melhor desempenho, segurança aprimorada e novos recursos, atualize para a última versão do GitHub Enterprise. Para obter ajuda com a atualização, entre em contato com o suporte do GitHub Enterprise.

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 ajudar você a colocar em funcionamento a API do GraphQL:

Para obter mais informações sobre as APIs do GitHub, confira "Sobre as APIs do GitHub".

Sobre o GraphQL

A linguagem de consulta de dados GraphQL é:

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

  • Fortemente tipada. O esquema define o sistema de tipos e todas as relações de objeto de uma API.

  • Introspectiva. Um cliente pode consultar o esquema para ver detalhes sobre o esquema.

  • Hierárquica. A forma de uma chamada do GraphQL espelha a forma dos dados JSON retornados. Os campos aninhados permitem consultar e receber apenas os dados especificados em uma só ida e volta.

  • Uma camada de aplicativo. O GraphQL não é um modelo de armazenamento nem uma linguagem de consulta de banco de dados. O grafo refere-se a estruturas de grafo definidas no esquema, em que nós definem os objetos e bordas definem as relações entre 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, porque oferece muito mais flexibilidade para os nossos integradores. A capacidade de definir com precisão os dados desejados (e apenas os dados desejados) são uma excelente vantagem em relação aos pontos de extremidade tradicionais da API REST. O GraphQL permite que você substitua várias solicitações da REST por uma só chamada para buscar os dados especificados.

Para obter mais detalhes sobre por que o GitHub investiu no GraphQL, confira a postagem no blog do comunicado original.

Sobre a referência do esquema do GraphQL

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

Acesse esse mesmo conteúdo por meio da barra lateral do Explorer Docs. 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

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 Discussões sobre APIs e integrações na Comunidade do GitHub. As discussões são moderadas e mantidas pela equipe do GitHub, mas não é garantido que as perguntas publicadas no fórum recebam uma resposta da equipe do GitHub.

Considere a possibilidade de entrar em contato diretamente com o Suporte do GitHub 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