Представляем описание GitHub OpenAPI
В блоге GitHub, вышла новость о презентации описания GitHub OpenAPI. Предлагаем вам ознакомиться с ее переводом на русский. Оригинал новости можно увидеть по ссылке.
С момента его первого выхода GitHub REST API был выпущен в трёх основных редакциях. И это всего через месяц после запуска сайта. Мы часто получаем отзывы о том, что наш REST API вдохновляет в архитектуре, и что он является отраслевым справочником того, как вообще должен выглядеть API. Сегодня мы рады объявить об улучшении способов взаимодействия разработчиков с нашим API. Доступен исходный код описания REST API средствами OpenAPI.
OpenAPI
Спецификация OpenAPI — это стандарт агностического языка программирования, позволяющий провайдерам описывать интерфейс своих HTTP API. Это позволяет как людям, так и машинам открыть возможности API без необходимости читать документацию или понимать реализацию. OpenAPI — широко принятый отраслевой стандарт. GitHub гордится тем, что является частью сообщества и помогает продвигать этот стандарт.
Посмотрите на OpenAPI в действии
Описание GitHub OpenAPI содержит более 600 операций, представленных в нашем API. Для визуального изучения API можно загрузить описание в виде коллекции Postman. В программном отношении описание может использоваться для генерации мок-серверов, тестовых наборов и привязок для языков, не поддерживаемых Octokit.
Описание представлено в двух форматах. Версия bundled предпочтительна в большинстве случаев: она работает с компонентами OpenAPI в целях повторного использования и удобочитаемости. Для инструментов с плохой поддержкой встроенных ссылок на компоненты мы также предоставляем версию без ссылок dereferenced.
Активная разработка
Описание сейчас на стадии beta: двенадцатилетний REST API — непростая задача. Мы создали это описание, смешав существующие схем JSON, документированные примеры, тестирование контрактов и, конечно, добавили любви. Мы хотим сделать его ещё более полным и точным по мере продвижения вперёд, а также по мере того, как OpenAPI становится центральным элементом нашей разработки — снаружи и внутри.
Ежеквартальные выпуски описания доступны для GitHub Enterprise Server и Github Private с версиями, подобными v2.21. Более частые обновления описания будут доступны на GitHub.com.
Как вы можете внести вклад?
Мы всегда стремимся сделать описание OpenAPI полнее, точнее и удобнее. Если вы хотите внести свой вклад, ознакомьтесь с нашим руководством. Если у вас что-то не работает, пожалуйста, сообщите о проблеме в репозитории.
Узнайте больше об описании REST API средствами OpenAPI.
