Tutoriel sur l'explorateur d'API NerdGraph

Configurer l'explorateur d'API NerdGraph

1. Allez à one.newrelic.com > All capabilities > Apps > NerdGraph API explorer.

2. Dans le champ User key , entrez une clé utilisateurAPI et cliquez sur Submit. Vous devrez copier une clé depuis l'UI de clé d'API.

   

Créez une requête pour récupérer votre nom

Commençons par une simple requête NerdGraph pour rechercher votre nom dans l'API GraphQL.

Si vous ne voyez pas la requête par défaut ci-dessous, effacez tout dans l'éditeur de requête et sélectionnez ces champs dans l'explorateur de requête dans cet ordre : actor, user, name:

{
  actor {
    user {
      name
    }
  }
}

Avec cette requête, vous demandez à NerdGraph de récupérer le champ name , qui est imbriqué dans le champ user . Le champ user fait référence au propriétaire de la clé utilisateur et user est imbriqué dans actor (l'entrée de niveau supérieur dans toutes les données limitées au niveau d'accès de l'utilisateur de l'API).

Exécuter la requête

Cliquez sur le bouton rouge Execute query . Notez que les résultats ont presque la même forme que la demande. Tous les champs du générateur de requêtes constituent le schéma GraphQL , qui décrit tous les types de données disponibles et leurs attributs. Pour en savoir plus sur chaque champ, cliquez sur l’icône en forme de loupe à côté du champ.

Ajoutez plus de champs à votre requête

Vous pouvez maintenant essayer d’ajouter plus de champs à votre requête. Le moyen le plus simple est de cliquer sur les champs dans le générateur de requêtes. L'explorateur sait où placer l'attribut dans la requête. Dans l'exemple, ajoutez les champs suivants :

• Compte id (Vous pouvez trouver la valeur de celui-ci en cliquant sur votre nom dans le coin inférieur gauche, puis en cliquant sur API Keys)

• email

  Lorsque vous exécutez la requête, elle renvoie uniquement les données dont vous avez besoin, sans sur-récupération ni sous-récupération des données. Notez que le champ id a un argument : passer des arguments est un moyen puissant de personnaliser votre requête NerdGraph. Chaque champ et objet peut contenir des arguments, donc au lieu d'exécuter plusieurs requêtes, vous composez simplement celle dont vous avez besoin.

  {
    actor {
      user {
        name
        email
      }
      account(id: INSERT_YOUR_OWN_ACCOUNT_ID)
    }
  }

  Copier

Expérimenter avec des mutations

Dans GraphQL, les mutations sont un moyen d'exécuter des requêtes avec des effets secondaires qui peuvent modifier les données en créant, en mettant à jour ou en supprimant des objets (dans API REST, elles sont communément appelées opérations CRUD).

Prêt pour votre première mutation ?

1. Effacer ce qui se trouve dans l'éditeur.

2. Faites défiler le générateur de requêtes et développez mutation.

3. Faites défiler jusqu’à tagging et sélectionnez taggingAddTagsToEntity.

4. Sélectionnez les champs suivants :

   • guid!: (Vous pouvez le trouver en ouvrant All entities, en cliquant sur l'icône ... dans votre enregistrement d'entité, puis en cliquant sur See metadata & tags)

   • tags!:

     • key!:
     • values:

   • errors

     • message
     • type
   

   Dans ce cas, vous ajoutez une tag personnalisée à une entité. L'éditeur se plaindra si vous ne sélectionnez pas errors: les mutations doivent avoir un moyen de vous indiquer comment l'opération a été effectuée dans le backend ( requests ayant échoué entraînent des réponses nulles).

   Conseil

   Contrairement à REST, les API GraphQL comme NerdGraph peuvent renvoyer des réponses partielles. Par exemple, si vous essayez d'ajouter une balise à plusieurs entités, certaines mutations peuvent échouer et d'autres réussir ; tout est enregistré dans la réponse GraphQL que vous obtenez.

Essayez votre requête NerdGraph dans le terminal

Disons que vous avez créé une requête NerdGraph qui vous convient et que vous souhaitez la tester ailleurs. Pour capturer les requêtes et les mutations prêtes pour le code :

1. Sélectionnez le menu Tools .

2. Copiez la requête sous forme d’appel curl ou sous forme de commande CLI New Relic .

   
   bash

   Copier

   $
   # curl version
   $
   curl https://api.newrelic.com/graphql \
   >
     -H 'Content-Type: application/json' \
   >
     -H 'Api-Key: API_KEY_REDACTED' \
   >
     --data-binary '{"query":"{\n  actor {\n    user {\n      name\n      email\n    }\n    account(id: 12345678)\n  }\n}\n", "variables":""}'
   $
   
   $
   # New Relic CLI version
   $
   newrelic nerdgraph query '{
   $
     actor {
   $
       user {
   $
         name
   $
         email
   $
       }
   $
       account(id: 12345678)
   $
     }
   $
   }'