Представляем Описание Github Openapi



Представляем описание 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 вы можете скачать описание в виде Коллекции почтальонов .

Программно описание можно использовать для генерации макетов серверов, тестовых примеров и привязок для неподдерживаемых языков.

октокит .

Описание представлено в двух форматах.

Версия в комплекте предпочтительнее в большинстве случаев: он работает с Компоненты OpenAPI для целей повторного использования и удобства чтения.

Для инструментов с плохой поддержкой встроенных ссылок на компоненты мы также предоставляем версию без ссылок.

разыменован .



Активное развитие

Описание сейчас в разработке бета : REST API двенадцатилетней давности — непростая задача.

Мы создали это описание, смешав существующие схемы JSON, документированные примеры, контрактное тестирование и, конечно же, добавив немного любви.

Мы хотим сделать его еще более полным и точным по мере продвижения вперед и по мере того, как OpenAPI становится центральным элементом нашей разработки — внутри и снаружи.

Ежеквартальные выпуски технических документов доступны для GitHub Enterprise Server и Github Private с такими версиями, как v2.21 .

Более частые обновления описаний будут доступны на GitHub.com.

Как вы можете внести свой вклад?

Мы всегда стремимся сделать описание OpenAPI более полным, точным и удобным.

Если вы хотите внести свой вклад, посетите наш управление .

Если у вас что-то не работает, сообщите о проблеме в репозиторий.

Узнайте больше о описание REST API с использованием OpenAPI .



Представляем описание GitHub OpenAPI

Теги: #ruvds_news #github #api #openapi #open source

Вместе с данным постом часто просматривают:

Автор Статьи


Зарегистрирован: 2019-12-10 15:07:06
Баллов опыта: 0
Всего постов на сайте: 0
Всего комментарий на сайте: 0
Dima Manisha

Dima Manisha

Эксперт Wmlog. Профессиональный веб-мастер, SEO-специалист, дизайнер, маркетолог и интернет-предприниматель.