Tutorial del explorador de API NerdGraph

Configurar el explorador de API NerdGraph

1. Vaya a one.newrelic.com > All capabilities > Apps > NerdGraph API explorer.

2. En el menú desplegable clave de API, seleccione una clave de usuario de API existente o agregue una nueva.

   

Cree una consulta para recuperar su nombre

Comencemos con una consulta simple de NerdGraph para buscar su nombre en la API GraphQL.

Si no ve la consulta predeterminada a continuación, borre todo en el editor de consultas y seleccione estos campos en el explorador de consultas en este orden: actor, user, name:

{
  actor {
    user {
      name
    }
  }
}

Con esta consulta, le pide a NerdGraph que recupere el campo name , que está anidado dentro del campo user . El campo user hace referencia al propietario de la clave de usuario y user está anidado dentro de actor (la entrada de nivel superior en todos los datos que se limita al nivel de acceso del usuario de API).

Ejecutar la consulta

Haga clic en el botón rojo Execute query . Tenga en cuenta que los resultados tienen casi la misma forma que la solicitud. Todos los campos del generador de consultas conforman el esquema GraphQL, que describe todos los tipos de datos disponibles y sus atributos. Para obtener más información sobre cada campo, haga clic en el icono de lupa al lado del campo.

Añade más campos a tu consulta

Ahora puede intentar agregar más campos a su consulta. La forma más sencilla es hacer clic en los campos del generador de consultas. El explorador sabe dónde colocar el atributo en la consulta. En el ejemplo, agregue los siguientes campos:

• Cuenta id (puede encontrar el valor de esto haciendo clic en su nombre en la esquina inferior izquierda y luego haciendo clic en

  API Keys

  )

• email

  Cuando ejecuta la consulta, devuelve solo los datos que necesita, sin obtener datos excesivos ni insuficientes. Observe que el campo id tiene un argumento: pasar argumentos es una forma poderosa de personalizar su consulta NerdGraph. Cada campo y objeto puede contener argumentos, por lo que en lugar de ejecutar varias consultas, simplemente redacta la que necesitas.

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

  Copia

Experimentar con mutaciones

En GraphQL, las mutaciones son una forma de ejecutar consultas con efectos secundarios que pueden alterar los datos mediante la creación, actualización o eliminación de objetos (en las API REST, comúnmente se denominan operaciones CRUD).

¿Listo para tu primera mutación?

1. Borra lo que hay en el editor.

2. Desplácese hacia abajo en el generador de consultas y expanda mutation.

3. Desplácese hacia abajo hasta tagging y seleccione taggingAddTagsToEntity.

4. Seleccione los siguientes campos:

   • guid!: (Puede encontrar esto abriendo

     All entities

     , haciendo clic en el icono

     ...

     en su registro de entidad y haciendo clic en

     See metadata & tags

     )

   • tags!:

     • key!:
     • values:

   • errores

     • mensaje
     • tipo
   

   En este caso, agrega una etiqueta personalizada a una entidad. El editor se quejará si no selecciona errors: las mutaciones deben tener una forma de indicarle cómo se realizó la operación en el backend (las solicitudes fallidas dan como resultado respuestas nulas).

   Sugerencia

   A diferencia de REST, las API GraphQL como NerdGraph pueden devolver respuestas parciales. Por ejemplo, si intenta agregar una etiqueta a varias entidades, algunas mutaciones pueden fallar y otras tener éxito; Todo es iniciar sesión en la respuesta GraphQL que obtienes.

Pruebe su consulta NerdGraph en la terminal

Supongamos que ha creado una consulta NerdGraph con la que está satisfecho y desea probarla en otro lugar. Para capturar consultas y mutaciones listas para el código:

1. Seleccione el menú

   Tools

   .

2. Copie la consulta como una llamada curl o como un comando CLI de New Relic .

   
   bash

   Copia

   $
   # 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)
   $
     }
   $
   }'