Сведения об описаниях OpenAPI
OpenAPI является стандартной спецификацией для описания REST API. Описания OpenAPI позволяют как людям, так и компьютерам обнаруживать возможности API без необходимости предварительного чтения документации или изучения реализации. GitHub сделал свои REST API общедоступными в виде документа, совместимого с OpenAPI 3.0.
Получение описания OpenAPI GitHub
Это описание можно найти в репозитории Описание OpenAPI REST API с открытым кодом.
Описание предоставляется в двух форматах. Пакетная версия работает в большинстве случаев, так как она включает компоненты OpenAPI для неоднократного использования и удобочитаемости. Если ваши средства не поддерживают встроенные ссылки на компоненты, мы также предоставляем полностью разыменованную версию.
Использование описания OpenAPI GitHub
Существует множество способов использования описания OpenAPI. Например, можно сделать следующее:
- Создать собственный клиент API.
- Проверять и тестировать интеграцию REST API GitHub.
- Исследовать и взаимодействовать с REST API GitHub Enterprise Server с помощью сторонних средств, таких как Insomnia или Postman.
Например, GitHub использует описание OpenAPI REST для создания справочной документации по REST API GitHub Enterprise Server.