{"meta":{"title":"Acerca de la descripción de OpenAPI para la API de REST","intro":"La GitHub API REST se describe completamente en un documento compatible con OpenAPI.","product":"REST API","breadcrumbs":[{"href":"/es/rest","title":"REST API"},{"href":"/es/rest/about-the-rest-api","title":"Acerca de la API de REST"},{"href":"/es/rest/about-the-rest-api/about-the-openapi-description-for-the-rest-api","title":"Descripción de OpenAPI"}],"documentType":"article"},"body":"# Acerca de la descripción de OpenAPI para la API de REST\n\nLa GitHub API REST se describe completamente en un documento compatible con OpenAPI.\n\n## Acerca de OpenAPI\n\nOpenAPI es una especificación que se usa para describir las interfaces de API de REST. Describe la API sin necesidad de acceso al código fuente ni a documentación adicional. La especificación es legible tanto por humanos como por máquinas. Para obtener más información, consulta la [documentación de especificación de OpenAPI](https://spec.openapis.org/oas/v3.1.0).\n\n## Acerca de la descripción de OpenAPI de GitHub\n\nGitHubLa descripción de OpenAPI de la API REST está disponible públicamente. Puede encontrar la descripción en el repositorio código abierto [github/rest-api-description](https://github.com/github/rest-api-description).\n\nGitHub proporciona descripciones de OpenAPI 3.0 y 3.1.\n\nPara cada descripción, hay una versión para cada producto: GitHub Free/GitHub Pro/GitHub Team(`api.github.com`), GitHub Enterprise Cloud (`ghec`) y cada versión de GitHub Enterprise Server ().`ghes-X.X`\n\nPara cada producto, si se admite el control de versiones basado en fechas, también hay una descripción para cada versión basada en fechas. Para más información, consulta [Versiones de API](/es/rest/about-the-rest-api/api-versions).\n\nCada descripción está disponible en un formato agrupado o desreferenciado. El formato agrupado usa `$ref` para hacer referencia a los componentes de OpenAPI que se comparten entre puntos de conexión. El formato desreferenciado incluye la descripción totalmente expandida.\n\n## Uso de la descripción de GitHub OpenAPI\n\nDado que la descripción de OpenAPI es legible por máquina, puede usarla para hacer cosas como las siguientes:\n\n* Generar bibliotecas para facilitar el uso de la API de REST\n* Validar y probar una integración que usa la API de REST\n* Explorar e interactuar con la API de REST mediante herramientas de terceros como Insomnia o Postman\n\nPor ejemplo, GitHub usa la descripción de OpenAPI para generar los SDK de Octokit.\nGitHub también usa la descripción de OpenAPI para generar la documentación de referencia de la API REST para cada punto de conexión."}