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