Сведения о OpenAPI
OpenAPI — это спецификация для описания интерфейсов REST API. Он описывает API без доступа к исходному коду или дополнительной документации. Спецификация — это человеческая и машинная удобочитаемая. Дополнительные сведения см . в документации по спецификации OpenAPI.
Описание GitHubOpenAPI
GitHubОписание OpenAPI REST API доступно в общедоступном виде. Описание можно найти в репозитории открытый код github/rest-api-description.
GitHub предоставляет описания OpenAPI как 3.0, так и 3.1.
Для каждого описания существует версия для каждого продукта: GitHub FreeGitHub Pro//GitHub Team(), GitHub Enterprise Cloud (ghec``api.github.com) и каждой GitHub Enterprise Server версии ().ghes-X.X
Для каждого продукта, если поддерживается управление версиями на основе дат, существует также описание каждой версии на основе дат. Дополнительные сведения см. в разделе Версии API.
Каждое описание доступно в пакетном или в разыменоваемом формате. Пакетный формат используется $ref для ссылки на компоненты OpenAPI, которые совместно используются между конечными точками. Формат разыменовки включает полностью развернутое описание.
GitHub Использование описания OpenAPI
Так как описание OpenAPI доступно для чтения на компьютере, его можно использовать для выполнения таких действий:
- Создание библиотек для упрощения использования REST API
- Проверка и проверка интеграции, которая использует REST API
- Изучение и взаимодействие с REST API с помощью сторонних средств, таких как бессонница или Postman
Например, GitHub использует описание OpenAPI для создания пакетов SDK octokit. GitHub также использует описание OpenAPI для создания справочной документации по REST API для каждой конечной точки.