Utilisation des clients GraphQL

Utilisation des IDE client GraphQL

Il existe de nombreux IDE clients GraphQL open source que vous pouvez utiliser pour accéder à l’API GraphQL de GitHub.

Consultez Formation d’appels avec GraphQL pour obtenir des informations détaillées sur les méthodes HTTP, l’authentification et la structure des appels GraphQL.

Tout d’abord, choisissez un client. Les options courantes comprennent GraphiQL, Insomnia et Altair (bureau/web/extension). Vous pouvez consulter la liste complète des clients dans le répertoire des outils de l’organisation GraphQL.

Les instructions génériques suivantes fonctionneront avec la plupart des clients GraphQL :

Dirigez le client vers le point de terminaison GraphQL : http(s)://HOSTNAME/api/graphql.
Ajoutez un en-tête Authorization : Authorization: Bearer TOKEN (remplacez TOKEN par votre GitHub personal access token. Pour plus d’informations, consultez Gestion de vos jetons d'accès personnels).
Définissez la méthode de requête sur POST ou, si disponible, utilisez le mode GraphQL fourni par le client.
Entrez votre requête ou votre mutation dans l’éditeur et, si nécessaire, fournissez des variables dans le panneau « Variables ».

Exemple :
```
query {
  viewer {
    login
  }
}
```
Si votre client a besoin d’un schéma pour le rendu de la documentation ou la saisie semi-automatique, récupérez-le via une requête d’introspection GraphQL. De nombreux clients peuvent le faire automatiquement à partir du panneau « Docs ».

Requête d’introspection minimale :
```
query IntrospectionQuery {
  __schema {
    types {
      name
    }
  }
}
```
Exécutez la requête et inspectez la réponse JSON. La requête de l’exemple doit renvoyer l’identifiant associé à GitHub personal access token avec lequel vous vous êtes authentifié.

Utilisez l’interface utilisateur client pour explorer les documents, exécuter des requêtes et enregistrer les requêtes si nécessaire.

GitHub CLI

Vous pouvez également utiliser la ligne de commande avec GitHub CLI pour exécuter des requêtes GraphQL.

Installez et authentifiez-vous avec GitHub CLI.
Exécutez une requête sur http(s)://HOSTNAME/api/graphql à l’aide du point de terminaison GraphQL avec la sous-commande gh api.

Exemple :

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

Cela devrait renvoyer l’identifiant associé à GitHub personal access token avec lequel vous vous êtes authentifié.

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
Les demandes de support impliquant des données sensibles ou des préoccupations d’ordre privé
Demandes de fonctionnalités
Commentaires sur les produits GitHub

Dans cet article

Utilisation des IDE client GraphQL

GitHub CLI

Demande de support