À propos de l’API GraphQL

Vue d’ensemble

Voici quelques liens rapides pour vous aider à devenir opérationnel avec l’API GraphQL :

Pour plus d’informations sur les API de GitHub, consultez Comparaison de l’API REST de GitHub et de l’API GraphQL.

À propos de GraphQL

Le langage de requête de données GraphQL est :

Une spécification. La spécification détermine la validité du schéma sur le serveur API. Le schéma détermine la validité des appels clients.
Fortement typé. Le schéma définit le système de type et toutes les relations d’objet d’une API.
Introspectif. Un client peut interroger le schéma afin d’obtenir des détails sur celui-ci.
Hiérarchique La forme d’un appel GraphQL reflète celle des données JSON qu’il retourne. Des champs imbriqués vous permettent d’interroger et recevoir uniquement les données que vous spécifiez en un seul aller-retour.
Une couche d’application GraphQL n’est pas un modèle de stockage ou un langage de requête de base de données. Le graphique fait référence à des structures graphiques définies dans le schéma, où des nœuds définissent des objets, et des arêtes définissent des relations entre ceux-ci. L’API traverse et retourne des données d’application en fonction des définitions du schéma, indépendamment de la façon dont les données sont stockées.

Pourquoi GitHub utilise GraphQL

GitHub a choisi GraphQL parce qu’il offre sensiblement plus de flexibilité pour nos intégrateurs. La possibilité de définir précisément les données que vous souhaitez —et uniquement celles-ci— offre un avantage puissant par rapport aux points de terminaison d’API REST traditionnels. GraphQL vous permet de remplacer plusieurs requêtes REST par un seul appel pour extraire les données que vous spécifiez.

Pour plus d’informations sur la raison qui a conduit GitHub à investir dans GraphQL, consultez le billet de blog d’annonce d’origine.

À propos de la référence du schéma GraphQL

Les documents dans la barre latérale sont générés à partir du schéma GraphQL GitHub. Tous les appels sont validés et exécutés par rapport au schéma. Utilisez ces documents pour découvrir les données que vous pouvez appeler :

Opérations autorisées : requêtes et mutations.
Types définis par le schéma : scalaires, objets, énumérations, interfaces, unions et objets d’entrée.

Vous pouvez accéder à ce même contenu via la barre latérale de la documentation d’Explorer. Notez qu’il se peut que vous deviez vous appuyer tant sur la documentation que sur la validation du schéma pour appeler correctement l’API GraphQL.

Pour d’autres informations, telles que des détails sur la limite de débit et l’authentification, consultez les guides.

Demande de support

Pour consulter les questions, les rapports de bogues et les discussions concernant GitHub Apps, OAuth apps et le développement d’API, explorez les Catégorie API et Webhooks dans les discussions de la communauté GitHub. Les discussions sont animées et gérées par le personnel GitHub et répondues par la communauté GitHub.

Envisagez de contacter le Support GitHub directement à l’aide du formulaire de contact pour :

réponse garantie du personnel de GitHub Enterprise Server
les demandes de soutien impliquant des données sensibles ou des préoccupations d’ordre privé
demandes de fonctionnalités
commentaires sur les produits GitHub Enterprise Server

Si vous observez des défaillances inattendues, vous pouvez utiliser githubstatus.com ou l’API d’état de GitHub pour vérifier si des incidents affectent l’API.