Режим совместимости со шлюзом API
API Designer предлагает режим совместимости со шлюзом API, чтобы помочь вам импортировать ваше определение в AWS API Gateway и Azure API Management.
При экспорте вашего API в режиме совместимости со шлюзом API Designer может изменить ваше определение, чтобы его можно было успешно импортировать в выбранный шлюз.
В некоторых случаях изменения не вносятся, но отображается сообщение, информирующее вас о проблеме совместимости, с которой вы можете столкнуться в экспортированном определении.
Экспорт определения OAS 3.0 для AWS API Gateway
В следующей таблице описывается, как API Designer обрабатывает функциональность, не поддерживаемую AWS API Gateway при экспорте определения, и что происходит в AWS API Gateway при импорте определения.
| Неподдерживаемая функциональность OpenAPI | Поведение API Designer при экспорте | Поведение AWS API Gateway при импорте |
|---|---|---|
| Атрибут example не поддерживается. | Атрибут сохраняется. | Атрибут удаляется из схемы. |
| Атрибут readOnly не поддерживается. | Атрибут сохраняется. | Атрибут удаляется из схемы. |
| Атрибут additionalProperties не поддерживается. | Атрибут сохраняется, и отображается информационное сообщение. | Отображается предупреждающее сообщение, но его можно проигнорировать, и определение будет успешно импортировано. |
Типы определений безопасности:
|
Схемы безопасности сохраняются, и отображается информационное сообщение. | Отображается предупреждающее сообщение, но его можно проигнорировать, и определение будет успешно импортировано. |
| Примитивные типы данных в ответах не поддерживаются. | Примитивный тип оборачивается в схему компонента, и отображается предупреждающее сообщение. | Импорт выполняется успешно. |
| Диапазоны типов мультимедиа не поддерживаются. | Запрос или ответ сохраняется, и отображается информационное сообщение. | Импорт завершается ошибкой, и отображается предупреждающее сообщение. |
| Ответ по умолчанию не поддерживается. | Ответ сохраняется, и отображается информационное сообщение. | Импорт завершается ошибкой, и отображается предупреждающее сообщение. |
| Диапазоны ответов не поддерживаются. | Ответ сохраняется, и отображается информационное сообщение. | Импорт завершается ошибкой, и отображается предупреждающее сообщение. |
| Переменные пути, параметры запроса и заголовки должны иметь уникальные имена. | Параметры сохраняются, и отображается сообщение об ошибке. | Импорт завершается ошибкой. |
Экспорт определения OAS/Swagger 2.0 для Azure API Management
В следующей таблице описывается, как API Designer обрабатывает функциональность, не поддерживаемую Azure API Management при экспорте определения, и что происходит в Azure API Management при импорте определения.
| Неподдерживаемая функциональность OpenAPI | Поведение API Designer при экспорте | Поведение Azure API Management при импорте |
|---|---|---|
| Обязательные параметры в путях и запросах должны иметь уникальные имена. | Отображается сообщение об ошибке. | Импорт завершается ошибкой. |