Acerca de la API de GraphQL

La API de GraphQL de GitHub ofrece flexibilidad y la capacidad de definir precisamente los datos que quieres recuperar.

Resumen

Aquí hay algunos enlaces rápidos para ponerte en marcha con la API de GraphQL v4:

Acerca de GraphQL

El lenguaje de consulta de GraphQL es:

  • Una especificación. La especificación determina la validez del modelo en el servidor de la API. El modelo determina la validez de las llamadas al cliente.

  • Lenguaje inflexible. El modelo define el sistema de tipos de la API y todas las relaciones con objetos.

  • Introspectivo. Un cliente puede consultar el modelo para obtener detalles del mismo.

  • Jerárquico. La forma de un llamado de GraphQL imita la forma de los datos JSON que recupera. Los Campos anidados te permiten consultar y recibir únicamente los dtos que especificas en una sola transacción.

  • Una capa de aplicación. GraphQL no es un modelo de almacenamiento o un lenguaje de consulta de bases de datos. graph se refiere a estructuras gráficas definidas en el modelo, en donde los nodos definen objetos y los bordes definen relaciones entre objetos. La API recorre y recupera datos de la aplicación basándose en las definiciones del modelo, independientemente de cómo se almacenan los datos.

Por qué GitHub utiliza GraphQL

GitHub eligió GraphQL para la API v4 porque ofrece significativamente más flexibilidad para nuestros intregradores. La capacidad de definir precisamente los datos que quieres —y únicamente estos— es una ventaja poderosa sobre las terminales de la API de REST v3. GraphQL te permite reemplazar varias solicitudes de REST con una sola llamada para agregar los datos que especifiques.

Para obtener más detalles acerca de por qué GitHub se ha migrado a GraphQL, consulta lapublicación de anuncios del blog.

Acerca de la referencia del modelo de GraphQL

Los documentos en la barra lateral se generan del modelo de GraphQL de GitHub. Todas las llamadas se validan y ejecutan contra el modelo. Utiliza estos documentos para encontrar los datos a los que puedes llamar:

Puedes acceder a este mismo contenido a través de la Barra lateral de documentos del explorador. Nota que podrías necesitar depender de ambos, los documentos y la validación del modelo, para hacer una llamada a la API de GraphQL.

Para obtener otro tipo de información, tal como los detalles de autenticación y el límite de tasas, revisa las guías.

Solicitar soporte

Para las preguntas, reportes de errores y debates sobre las GitHub Apps, OAuth Apps y el desarrollo de la API, explora el Foro de desarrollo y soporte de la API de GitHub. El foro se modera y mantiene con el personal de GitHub, pero no se garantiza que el personal de GitHub responda las preguntas que se publiquen en el mismo.

Considera contactar al Soporte de GitHub directamente utilizando el formato de contacto para:

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

¿Te ayudó este documento?

Política de privacidad

¡Ayúdanos a hacer geniales estos documentos!

Todos los documentos de GitHub son de código abierto. ¿Notas algo que esté mal o que no sea claro? Emite una solicitud de cambios.

Haz una contribución

O, aprende cómo contribuir.