Utilizar el Explorador

Acerca del explorador de GraphQL

GraphiQL, también mencionado en esta documentación como el explorador de GraphQL, es un "IDE de GraphQL gráfico e interactivo en el explorador".

Autocompletar consultas

Puede usar autocompletar consultas para ayudarle a crear consultas. En el panel principal, dentro de los corchetes de la consulta, use Control+Espacio o Mayúsculas+Espacio para mostrar el menú autocompletar.

Acceder a los documentos de la barra lateral

Todos los tipos en el esquema de GraphQL incluyen un campo description compilado en la documentación. El panel contraíble Docs (Documentos) en el lado derecho de la página del explorador le permite buscar documentación acerca de su tipo de sistema. Los documentos se actualizan automáticamente y quitarán los campos que están en desuso.

Utilizar el pánel de variable

Algunas llamadas de ejemplo incluyen variables escritas de la siguiente manera:

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

Este es el formato correcto para enviar la llamada mediante una solicitud POST en un comando curl (siempre que establezcas un carácter de escape en las líneas nuevas).

Si quiere ejecutar la llamada en el explorador, introduzca el segmento query en el panel principal y las variables en el panel Query Variables (Variables de Consulta) debajo de este. Omita la palabra variables del Explorador:

{
   "number_of_repos": 3
}

Uso del IDE de cliente de Altair GraphQL

Hay muchos IDE de cliente de código abierto de GraphQL. Por ejemplo, puedes usar Altair para acceder a GraphQL API de GitHub. Para acceder a GraphQL API con Altair, descárgala e instálada desde altair-graphql/altair. A continuación, sigue los pasos de configuración que se indican a continuación.

Configuración de Altair

1. Obtén un token de acceso.
2. Inicia Altair.
3. En la barra lateral izquierda, debajo del logotipo de Altair, haz clic en Establecer encabezados. Se abrirá una ventana nueva.
4. En el campo "Clave de encabezado", escribe Authorization.
5. En el campo "Valor de encabezado", escribe Bearer TOKEN, pero reemplaza TOKEN por el token del primer paso.
6. Haga clic en Guardar en la esquina inferior derecha de la ventana para guardar el encabezado de autorización.
7. En el campo "Punto de conexión de GraphQL", escribe http(s)://HOSTNAME/api/graphql.
8. Para cargar el esquema de GraphQL de GitHub, descarga el esquema público.
9. En Altair, haz clic en Documentos en la parte superior derecha y, luego, en los tres puntos y en Cargar esquema...
10. Selecciona el esquema público del archivo que descargaste en un paso anterior.

Puedes probar tu acceso si te consultas a ti mismo:

query {
  viewer {
    login
  }
}

Si todo funcionó correctamente, esto mostrará tu ingreso. Estás listo para comenzar a hacer consultas.

Solicitar soporte

Para las preguntas, reportes de errores y debates sobre las GitHub Apps, OAuth apps y el desarrollo de la API, explora Categoría API y webhooks en las discusiones de la comunidad de GitHub. El personal de GitHub modera y mantiene las discusiones y la comunidad de GitHub las responde.

Considera la posibilidad de ponerse en contacto con Soporte de GitHub directamente mediante el formulario de contacto para:

• respuestas garantizadas del personal de GitHub Enterprise Server
• solicitudes de soporte que involucren preocupaciones sobre datos sensibles o privados
• solicitudes de características
• retroalimentación sobre los productos de GitHub Enterprise Server

Solucionar errores

Dado que GraphQL es introspectivo, el Explorador admite lo siguiente:

• Autocompleción inteligente consciente del modelo actual
• Vistas previas de validación de errores mientras tecleas

Si escribe una consulta que no está bien formada o no pasa la validación del esquema, un elemento emergente le advierte de un error. Si ejecutas la consulta, el error se devolverá en el panel de respuesta.

Una respuesta de GraphQL contiene varias claves: un código hash data y una matriz errors.

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

Es posible que te encuentres con un error inesperado que no está relacionado con el modelo. Si esto pasa, el mensaje incluirá el código de referencia que puedes utilizar cuando reportas el problema:

{
  "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."
    }
  ]
}