Frecuentemente publicamos actualizaciones de nuestra documentación. Es posible que la traducción de esta página esté en curso. Para conocer la información más actual, visita la documentación en inglés. Si existe un problema con las traducciones en esta página, por favor infórmanos.
GitHub AE is currently under limited release. Please contact our Sales Team to find out more.

About the GraphQL API

The GitHub GraphQL API offers flexibility and the ability to define precisely the data you want to fetch.

En este artículo

Overview

Here are some quick links to get you up and running with the GraphQL API v4:

About GraphQL

The GraphQL data query language is:

  • A specification. The spec determines the validity of the schema on the API server. The schema determines the validity of client calls.

  • Strongly typed. The schema defines an API's type system and all object relationships.

  • Introspective. A client can query the schema for details about the schema.

  • Hierarchical. The shape of a GraphQL call mirrors the shape of the JSON data it returns. Nested fields let you query for and receive only the data you specify in a single round trip.

  • An application layer. GraphQL is not a storage model or a database query language. The graph refers to graph structures defined in the schema, where nodes define objects and edges define relationships between objects. The API traverses and returns application data based on the schema definitions, independent of how the data is stored.

Why GitHub is using GraphQL

GitHub chose GraphQL for our API v4 because it offers significantly more flexibility for our integrators. The ability to define precisely the data you want—and only the data you want—is a powerful advantage over the REST API v3 endpoints. GraphQL lets you replace multiple REST requests with a single call to fetch the data you specify.

For more details about why GitHub has moved to GraphQL, see the original announcement blog post.

About the GraphQL schema reference

The docs in the sidebar are generated from the GitHub GraphQL schema. All calls are validated and executed against the schema. Use these docs to find out what data you can call:

You can access this same content via the Explorer Docs sidebar. Note that you may need to rely on both the docs and the schema validation to successfully call the GraphQL API.

For other information, such as authentication and rate limit details, check out the guides.

Requesting support

Para preguntas, reportes de errores y debates sobre las App GitHub, App OAuth, y el desarrollo de API, explora el Foro de desarrollo y soporte de la API de GitHub. El foro se modera y mantiene con el personal de GitHub Enterprise, pero no se garantiza que el personal de GitHub Enterprise 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 Enterprise
  • solicitudes de soporte que involucren preocupaciones sobre datos sensibles o privados
  • solicitudes de características
  • retroalimentación sobre los productos de GitHub Enterprise

¿Te ayudó este documento?

Privacy policy

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

O, learn how to contribute.