Преобразования при экспорте
При экспорте определения, разработанного с использованием функциональности API Designer, в формат, который ее не поддерживает, определение изменяется в соответствии с целевым форматом. В процессе теряется часть выразительности.
В таблице ниже описаны изменения, вносимые в определение API при экспорте в одну из следующих спецификаций:
- OAS/Swagger 2.0
- Swagger 1.2
- RAML 1.0
| Неподдерживаемая функциональность | Преобразование |
|---|---|
| Компоненты | Компонент копируется в каждое место, где он используется. |
| Диапазоны ответов и ответы по умолчанию | Ответ удаляется. |
| Аутентификация Bearer и OpenID Connect | Схема безопасности удаляется. |
| Комбинации allOf | Комбинация заменяется объектом, содержащим все свойства всех используемых типов. |
| Комбинации anyOf и oneOf | Комбинация заменяется пустым объектом. |
| Несколько конечных точек | Первая опубликованная конечная точка включается в определение, остальные игнорируются. |
Спецификация OpenAPI 3.0 поддерживает URL-адреса только в поле Условия обслуживания. При экспорте определения в OAS 3.0 это поле экспортируется, только если оно содержит URL-адрес. Если это не так, поле Условия обслуживания игнорируется для обеспечения валидности определения.