Вы находитесь здесь:
Поддержка OpenAPI 2.0 и 3.0
Узнайте о действительных компонентах схемы API, которые можно использовать для успешной регистрации спецификации.
Требуемые версии
| Доступно в версиях: Lightning Experience |
| Доступно в версиях: Enterprise Edition, Performance Edition, Unlimited Edition и Developer Edition |
Вместе с обычной поддержкой пакетирования можно использовать:
- Вложенные параметры — отображаются как заданные динамическим Apex типы данных в Apex и Flow Builder.
- Именованные массивы, анонимные массивы или встроенные массивы, поддерживаемые как общий тип
Listв Apex или как типcollectionв Flow Builder. additionalPropertiesOpenAPI как общий типMapв Apex.- Параметры заголовка в запросах HTTP.
- Поддерживаются следующие медиа-типы:
application/json-- Структурированные данные в формате JSONapplication/x-www-form-urlencoded-- форма в кодировке URL-адресаtext/plain-- неструктурированные данные в виде обычного текста
- Неподдерживаемые медиа-типы могут быть соотнесены с поддерживаемыми медиа-типами для сериализации содержимого запроса и ответа. См. Соотнесение медиа-типов в регистрациях внешних служб.
- Параметры данных формы поддерживаются.
- Поддерживает все поддерживаемые Java кодировки набора символов. UTF-8 - это кодировка по умолчанию.
- OpenAPI 2.0: Директивы
consumesиproducesсервера и уровня работы. - OpenAPI 3.0: медиа-тип содержимого с поддерживаемыми медиа-типами.
Поддерживаемый формат схемы
- OpenAPI 2.0, формат схемы JSON
- OpenAPI 3.0, формат схемы JSON
- Схема OpenAPI 2.0, формат YAML
- Схема OpenAPI 3.0, формат YAML
- UTF-8, с полным набором символов для имен и идентификаторов
Неподдерживаемые форматы схем
- Формат гиперсхемы агента
Неподдерживаемые конструкции схемы
- OpenAPI 3.0: Ключевое слово составной схемы:
not - Медиа-типы, например, xml, png и pdf
Эта статья решила вашу проблему?
Оставьте свой отзыв, чтобы мы могли стать лучше!
