Utilisation d’Explorer

À propos de GraphQL Explorer

GraphiQL, également désigné dans cette documentation comme GraphQL Explorer, est un « IDE GraphQL interactif dans navigateur graphique ».

Autocomplétion de requête

Vous pouvez utiliser la saisie automatique des requêtes pour vous aider à générer des requêtes. Dans le volet principal, entre crochets curly de votre requête, utilisez l’espace de +contrôle ou l’espace de +décalage pour afficher le menu de saisie semi-automatique.

Accès aux documents de la barre latérale

Tous les types d’un schéma GraphQL incluent un champ description compilé dans la documentation. Le volet réductible Docs sur le côté droit de la page Explorer vous permet de parcourir la documentation sur le système type. Les documents sont automatiquement mis à jour et suppriment les champs déconseillés.

Utilisation du volet Variable

Voici quelques exemples d’appels qui incluent des variables écrites comme suit :

query($number_of_repos:Int!){
  viewer {
    name
     repositories(last: $number_of_repos) {
       nodes {
         name
       }
     }
   }
}
variables {
   "number_of_repos": 3
}

Il s’agit du format approprié pour envoyer l’appel à l’aide d’une requête POST dans une commande curl (tant que vous échappez des lignes).

Si vous souhaitez exécuter l’appel dans Explorer, entrez le segment query dans le volet principal et les variables dans le volet Variables de requête en dessous. Omettez le mot variables d’Explorer :

{
   "number_of_repos": 3
}

Utilisation de l’IDE Altair GraphQL Client

Il existe de nombreux IDE de clients GraphQL open source. Par exemple, vous pouvez utiliser Altair pour accéder à l’API GraphQL de GitHub. Pour accéder à l’API GraphQL avec Altair, téléchargez-la à partir de la page altair-graphql/altair et installez-la. Ensuite, effectuez les étapes de configuration ci-dessous.

Configuration d’Altair

1. Obtenez un jeton d’accès.
2. Lancez Altair.
3. Dans la barre latérale gauche, sous le logo Altair, cliquez sur Set Headers. Une nouvelle fenêtre s’ouvre.
4. Dans le champ « Header key », entrez Authorization.
5. Dans le champ « Header value », entrez Bearer TOKEN, en remplaçant TOKEN par votre jeton de la première étape.
6. Cliquez sur Save dans le coin inférieur droit de la fenêtre pour enregistrer votre en-tête d’autorisation.
7. Dans le champ « GraphQL Endpoint », entrez http(s)://<em>HOSTNAME</em>/api/graphql.
8. Pour charger le schéma GraphQL GitHub, téléchargez le schéma public.
9. Dans Altair, cliquez sur Docs en haut à droite, sur les trois points, puis sur Load Schema...
10. Sélectionnez le schéma public de fichier que vous avez téléchargé lors d’une étape précédente.

Vous pouvez tester votre accès en vous interrogeant vous-même :

query {
  viewer {
    login
  }
}

Si tout a fonctionné correctement, votre connexion s’affiche. Vous êtes tous prêts à commencer à effectuer des requêtes.

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

Dépannage des erreurs

Étant donné que GraphQL est introspectif, Explorer prend en charge :

• les typesaheads intelligents prenant en compte le schéma actuel
• les aperçus des erreurs de validation lors de la saisie

Si vous entrez une requête qui n’est pas correctement formée ou ne passe pas la validation de schéma, une fenêtre contextuelle vous avertit d’une erreur. Si vous exécutez la requête, l’erreur est retournée dans le volet réponse.

Une réponse GraphQL contient plusieurs clés : une synthèse data et un tableau errors.

{
  "data": null,
  "errors": [
    {
      "message": "Objects must have selections (field 'nodes' returns Repository but has no selections)",
      "locations": [
        {
          "line": 5,
          "column": 8
        }
      ]
    }
  ]
}

Il est possible de rencontrer une erreur inattendue qui n’est pas liée au schéma. Dans ce cas, le message inclut un code de référence que vous pouvez utiliser lors de la création de rapports sur le problème :

{
  "data": null,
  "errors": [
    {
      "message": "Something went wrong while executing your query. This is most likely a GitHub bug. Please include \"7571:3FF6:552G94B:69F45B7:5913BBEQ\" when reporting this issue."
    }
  ]
}