OpenAPI Specification
OAS 3.1.1 Released!
Спецификация OpenAPI представляет собой открытую спецификацию, основанную на сообществе в рамках инициативы OpenAPI, совместного проекта Linux Foundation.
Спецификация OpenAPI (OAS) определяет стандартное описание языка программирования-алкогольного интерфейса для API HTTP. Это позволяет как людям, так и компьютерам обнаруживать и понимать возможности услуги, не требуя доступа к исходному коду, дополнительной документации или проверки сетевого трафика. При правильном определении через OpenAPI потребитель может понять и взаимодействовать с удаленным обслуживанием с минимальным количеством логики реализации. Подобно тому, что описаны интерфейс для программирования нижнего уровня, спецификация OpenAPI удаляет догадки при вызове службы.
Варианты использования документов по определению API, читаемых на машиночитании, включают, но не ограничиваются: интерактивная документация; генерация кода для документации, клиентов и серверов; и автоматизация тестовых случаев. Документы OpenAPI описывают услуги API и представлены в форматах YAML или JSON. Эти документы могут быть произведены и обслуживались статически или динамически генерируются из приложения.
Спецификация OpenAPI не требует переписывания существующих API. Он не требует привязки какого -либо программного обеспечения с сервисом - описанная служба может даже не принадлежать создателю его описания. Однако он требует, чтобы возможности службы были описаны в структуре спецификации OpenAPI. Не все услуги могут быть описаны OpenAPI - эта спецификация не предназначена для охвата каждого возможного стиля API HTTP, но включает в себя поддержку API REST. Спецификация OpenAPI не требует конкретного процесса разработки, такого как проектирование-первое или код. Он облегчает любую технику путем установления четких взаимодействий с HTTP API.
Этот проект GitHub является отправной точкой для OpenAPI. Здесь вы найдете необходимую информацию о спецификации OpenAPI, простых примерах того, как она выглядит, и некоторую общую информацию о проекте.
Этот репозиторий содержит источники отметки для всех опубликованных версий Specifive Speciation. Для выпуска заметок и выпуска версий кандидатов обратитесь на страницу релизов.
Каждая папка в этом репозитории, такая как схемы и тесты, должна содержать папки, относящиеся к текущим и предыдущим версиям спецификации.
Если вы просто хотите, чтобы это работало, ознакомьтесь с списком текущих примеров.
Хотите увидеть, как вы можете создать свое собственное определение OpenAPI, представить его или иным образом использовать его? Проверьте растущий список реализаций.
Текущий процесс разработки спецификации OpenAPI описан в руководящих принципах.
Разработка следующей версии спецификации OpenAPI руководствуется Техническим руководящим комитетом (TSC). Эта группа комитетов приносит свой опыт в API, включает в себя отзывы сообщества и расширяет группу комитетов в зависимости от необходимости. Вся деятельность по развитию в будущей спецификации будет выполнена в качестве функций и объединена в эту ветвь. После выпуска будущей спецификации этот ветвь будет объединен с main .
TSC проводит еженедельные веб -конференции для просмотра открытых запросов на привлечение и обсуждения открытых вопросов, связанных с развивающейся спецификацией OpenAPI. Участие в еженедельных звонках и запланированных рабочих сессиях открыто для сообщества. Вы можете просмотреть весь календарь технических встреч OpenAPI онлайн.
Инициатива OpenAPI поощряет участие как отдельных лиц, так и компаний. Если вы хотите участвовать в эволюции спецификации OpenAPI, рассмотрите возможность предпринять следующие действия:
Не все отзывы могут быть предоставлены, и могут быть твердые аргументы для или против изменений, подходящих для спецификации.
См.: Лицензия (Apache-2.0)
