Поддержка спецификации OpenAPI 3.0 | Qlik Cloud Справка
Перейти к основному содержимому Перейти к дополнительному содержимому
Ресурсы Qlik
Загрузка поиска SearchUnify Если вам нужна помощь с вашим продуктом, обратитесь в поддержку Qlik.
Портал клиентов Qlik
Загрузка поиска SearchUnify Если вам нужна помощь с вашим продуктом, обратитесь в поддержку Qlik.
Портал клиентов Qlik

Поддержка спецификации OpenAPI 3.0

Последнее обновление: 09.10.2026
Спроектируйте API на основе OpenAPI Specification (OAS) 3.0 с помощью контрактов API.

Спецификация OpenAPI 3.0 включает в себя новые возможности, обеспечивая большую выразительность и продуктивность для проектировщиков API.

Дополнительные сведения об OpenAPI см. в документации Swagger.

Компоненты

Компоненты позволяют повторно использовать различные элементы в рамках API. Эти элементы могут быть:
  • Переменные пути
  • Query Parameters (Параметры запроса)
  • Заголовки
  • Ответы

Комбинации

Комбинации позволяют создать новый тип данных путем объединения нескольких других типов данных. API Contracts поддерживает два типа комбинаций:
  • Композиция (allOf) позволяет агрегировать свойства схем из различных схем. Например, можно определить тип данных Company, повторно используя все свойства существующих типов Contact и Error.
    Пример композиции.
  • Полиморфизм (oneOf/anyOf) позволяет создать сущность, которая может использовать свойства различных типов данных.
    • oneOf позволяет определить тип данных, содержащий свойства одного из выбранных типов. Например, если вы создаете операцию для получения информации о сервисной учетной записи, вы можете определить ответ с помощью комбинации oneOf, чтобы получить либо все свойства Error, либо все свойства ServiceAccountCount.
      Пример полиморфизма.
    • anyOf позволяет определить тип данных, содержащий свойства одного или нескольких выбранных типов. Например, вы можете определить тип данных nervousSystem и тип skeleton, содержащие различные свойства, и использовать комбинацию anyOf для создания типа данных, содержащего любые свойства любого из этих типов.

      Комбинация anyOf считается допустимой при условии, что она содержит все обязательные параметры хотя бы одного из выбранных типов данных. В приведенном ниже примере используются свойство brain_weight из типа nervousSystem и свойства skull_height и teeth из skeleton.

      Пример комбинации с использованием типов данных nervousSystem и skeleton.

Дополнительные сведения о композиции и полиморфизме см. в разделах Наследование и полиморфизм и Различия между anyOf и oneOf.

Ответы

OAS 3.0 позволяет определять новые типы ответов для ваших операций:
  • Диапазоны ответов: вместо определения такого ответа, как 200, можно указать 2XX, чтобы включить ответы от 200 до 299.
  • Ответы по умолчанию: вы можете задать ответ по умолчанию, который будет возвращаться, когда не определен конкретный ответ или диапазон ответов.
Ответы, определенные с явным кодом, имеют приоритет над диапазонами ответов и ответами по умолчанию, а диапазоны ответов имеют приоритет над ответами по умолчанию. В следующем примере:
  • Ответ 204 определен и имеет приоритет над остальными.
  • Ответ 2XX применяется к кодам ответа от 200 до 203 и от 205 до 299.
  • Ответ по умолчанию применяется ко всем ответам 1XX, 3XX, 4XX и 5XX.
Раздел ответов.

Безопасность

OAS 3.0 предлагает новые схемы безопасности для вашего API:
  • Аутентификация Bearer
  • OpenIdConnect

Ограничения

OAS 3.0 позволяет указать, что некоторые свойства доступны только для чтения или только для записи.

Этот параметр доступен только в типах данных и не может быть определен в запросах или ответах на уровне операции.

Пример ограничения.

Помогла ли вам эта страница?

Если вы обнаружили какую-либо проблему на этой странице или с ее содержанием — будь то опечатка, пропущенный шаг или техническая ошибка, сообщите нам об этом!

Оставьте свой отзыв здесь