Какие основные блоки входят в структуру спецификации OpenAPI?

Некоторые основные блоки, входящие в структуру спецификации OpenAPI:

• openapi — содержит номер версии спецификации OpenAPI. habr.com apigit.com
• info — содержит основную информацию об API: название, описание, версию, контакты разработчика спецификации и т. д.. habr.com
• servers — содержит информацию об используемых серверах, указывается базовый путь, который находится перед конечной точкой. habr.com Можно указать несколько вариантов — для разных сред разработки. habr.com
• paths — определяет конечные точки (URL-адреса) API и методы HTTP (GET, POST, PUT, DELETE и т. д.), которые можно использовать для доступа к ним. apigit.com
• components — содержит переиспользуемые элементы API, такие как схемы, схемы безопасности и ответы. apigit.com
• security — содержит информацию о безопасности, которая авторизует запрос. habr.com
• tags — предоставляет метаданные для группировки и организации операций и конечных точек. apigit.com
• externalDocs — содержит ссылки на внешнюю документацию, связанную с API. apigit.com

Полный список полей можно найти в официальной документации спецификации OpenAPI. apigit.com

Пользователь

Время добавления