{"meta":{"title":"Описание OpenAPI для REST API","intro":"GitHub REST API полностью описан в документе, совместимом с OpenAPI.","product":"REST API","breadcrumbs":[{"href":"/ru/rest","title":"REST API"},{"href":"/ru/rest/about-the-rest-api","title":"Сведения о REST API"},{"href":"/ru/rest/about-the-rest-api/about-the-openapi-description-for-the-rest-api","title":"Описание OpenAPI"}],"documentType":"article"},"body":"# Описание OpenAPI для REST API\n\nGitHub REST API полностью описан в документе, совместимом с OpenAPI.\n\n## Сведения о OpenAPI\n\nOpenAPI — это спецификация для описания интерфейсов REST API. Он описывает API без доступа к исходному коду или дополнительной документации. Спецификация — это человеческая и машинная удобочитаемая. Дополнительные сведения см [. в документации](https://spec.openapis.org/oas/v3.1.0) по спецификации OpenAPI.\n\n## Описание GitHubOpenAPI\n\nGitHubОписание OpenAPI REST API доступно в общедоступном виде. Описание можно найти в репозитории открытый код [github/rest-api-description](https://github.com/github/rest-api-description).\n\nGitHub предоставляет описания OpenAPI как 3.0, так и 3.1.\n\nДля каждого описания существует версия для каждого продукта: GitHub Free/GitHub Pro/GitHub Team(), `api.github.com` (GitHub Enterprise Cloud`ghec`) и каждой GitHub Enterprise Server версии ().`ghes-X.X`\n\nДля каждого продукта, если поддерживается управление версиями на основе дат, существует также описание каждой версии на основе дат. Дополнительные сведения см. в разделе [Версии API](/ru/rest/about-the-rest-api/api-versions).\n\nКаждое описание доступно в пакетном или в разыменоваемом формате. Пакетный формат используется `$ref` для ссылки на компоненты OpenAPI, которые совместно используются между конечными точками. Формат разыменовки включает полностью развернутое описание.\n\n## GitHub Использование описания OpenAPI\n\nТак как описание OpenAPI доступно для чтения на компьютере, его можно использовать для выполнения таких действий:\n\n* Создание библиотек для упрощения использования REST API\n* Проверка и проверка интеграции, которая использует REST API\n* Изучение и взаимодействие с REST API с помощью сторонних средств, таких как бессонница или Postman\n\nНапример, GitHub использует описание OpenAPI для создания пакетов SDK octokit.\nGitHub также использует описание OpenAPI для создания справочной документации по REST API для каждой конечной точки."}