Uso de clientes de GraphQL

You can run queries on real GitHub data using various GraphQL clients and libraries.

En este artículo

Uso de IDE de cliente de GraphQL

Hay muchos IDE de cliente de GraphQL de código abierto que puedes usar para acceder a la API GraphQL de GitHub.

Consulta Formar llamados con GraphQl para obtener información amplia sobre los métodos HTTP, la autenticación y la estructura de llamadas de GraphQL.

En primer lugar, elige un cliente. Entre las opciones comunes se incluyen GraphiQL, Insomnia, and Altair (para escritorio, web o extensión). Puedes ver la lista completa de clientes en el directorio de herramientas de la organización de GraphQL.

Las siguientes instrucciones genéricas funcionarán con la mayoría de los clientes de GraphQL:

  1. Apunta al cliente al punto de conexión de GraphQL: http(s)://HOSTNAME/api/graphql.

  2. Agregar un encabezado Authorization: Authorization: Bearer TOKEN (reemplaza TOKEN por tu GitHub personal access token. Para más información, consulta Administración de tokens de acceso personal).

  3. Establece el método de solicitud en POST o, si está disponible, usa el modo de GraphQL proporcionado por el cliente.

  4. Escribe la consulta o mutación en el editor y, si es necesario, proporciona variables en el panel "Variables".

    Ejemplo:

    query {
  viewer {
    login
  }
}

  5. Si el cliente necesita un esquema para la representación de documentación o autocompletar, lo puedes capturar mediante una consulta de introspección de GraphQL. Muchos clientes pueden hacerlo automáticamente desde el panel "Docs".

    Consulta de introspección mínima:

    query IntrospectionQuery {
  __schema {
    types {
      name
    }
  }
}

  6. Ejecuta la solicitud e inspecciona la respuesta JSON. La consulta del ejemplo debe devolver el inicio de sesión asociado con la instancia de GitHub personal access token con la que te has autenticado.

Usa la interfaz de usuario del cliente para explorar la documentación, ejecutar consultas y guardar solicitudes según sea necesario.

GitHub CLI

También puedes usar la línea de comandos con GitHub CLI para ejecutar consultas de GraphQL.

  1. Instala y autentícate con GitHub CLI.
  2. Ejecuta una consulta en http(s)://HOSTNAME/api/graphql mediante el punto de conexión de GraphQL con el subcomando gh api.

Ejemplo:

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

Esto debe devolver el inicio de sesión asociado con la instancia de GitHub personal access token con la que te has autenticado.

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
  • Solicitudes de soporte que involucren preocupaciones sobre datos confidenciales o privados
  • Solicitud de función
  • Comentarios sobre los productos de GitHub