Skip to main content

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.

Información general

Aquí tienes algunos enlaces rápidos para ayudarte a iniciar con la API de GraphQL:

Para más información sobre GitHub's APIs, consulta "Sobre las API de GitHub."

Acerca de GraphQL

El lenguaje de consulta de datos GraphQL es:

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

  • Establecimiento inflexible de tipos. El esquema define el sistema de tipos de una API y todas las relaciones de objetos.

  • Introspectivo. Un cliente puede consultar el esquema para obtener más información sobre él.

  • Jerárquico. La forma de una llamada de GraphQL refleja la forma de los datos JSON que se devuelven. Los campos anidados permiten consultar y recibir solo los datos que especifique en un solo recorrido de ida y vuelta.

  • Nivel de aplicación. GraphQL no es un modelo de almacenamiento ni un lenguaje de consulta de base de datos. El gráfico hace referencia a las estructuras de gráficos definidas en el esquema, 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ó a GraphQL porque ofrece significativamente más flexibilidad para nuestros integradores. La capacidad de definir exactamente los datos que desea— y solo los datos que desea— es una potente ventaja en comparación con los puntos de conexión de API de REST tradicionales. GraphQL le permite reemplazar varias solicitudes de REST con una sola llamada para obtener los datos que especifique.

Para obtener más información sobre por qué GitHub ha invertido en GraphQL, consulte la entrada de blog del anuncio original.

Acerca de la referencia del modelo de GraphQL

Los documentos de la barra lateral se generan a partir del esquema 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:

Puede acceder a este mismo contenido desde la barra lateral de Explorer Docs. 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, como los detalles de autenticación y límite de frecuencia, consulte 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 Discusiones sobre API e integraciones en la comunidad de GitHub. Los debates se moderan y mantienen con el personal de GitHub, pero no se garantiza que el personal de GitHub responda las preguntas que se publiquen en el foro.

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 sensibles o privados
  • solicitudes de características
  • retroalimentación sobre los productos de GitHub