Yandex Cloud
Поиск
Связаться с намиПодключиться
  • Документация
  • Блог
  • Все сервисы
  • Статус работы сервисов
    • Популярные
    • Инфраструктура и сеть
    • Платформа данных
    • Контейнеры
    • Инструменты разработчика
    • Бессерверные вычисления
    • Безопасность
    • Мониторинг и управление ресурсами
    • Машинное обучение
    • Бизнес-инструменты
  • Все решения
    • По отраслям
    • По типу задач
    • Экономика платформы
    • Безопасность
    • Техническая поддержка
    • Каталог партнёров
    • Обучение и сертификация
    • Облако для стартапов
    • Облако для крупного бизнеса
    • Центр технологий для общества
    • Облако для интеграторов
    • Поддержка IT-бизнеса
    • Облако для фрилансеров
    • Обучение и сертификация
    • Блог
    • Документация
    • Контент-программа
    • Мероприятия и вебинары
    • Контакты, чаты и сообщества
    • Идеи
    • Истории успеха
    • Тарифы Yandex Cloud
    • Промоакции и free tier
    • Правила тарификации
  • Документация
  • Блог
Проект Яндекса
© 2025 ООО «Яндекс.Облако»
Yandex API Gateway
  • Начало работы
    • Взаимосвязь ресурсов сервиса
    • Сетевое взаимодействие
      • Обзор
        • Статический ответ
        • Обращение по HTTP
        • Cloud Functions
        • Serverless Containers
        • Smart Web Security
        • Object Storage
        • DataSphere
        • Data Streams
        • Message Queue
        • Managed Service for YDB
      • Жадные параметры
      • Обобщенный HTTP-метод
      • Авторизация с помощью функции Cloud Functions
      • Авторизация с помощью JWT
      • Поддержка протокола WebSocket
      • Валидация данных
      • CORS
      • Параметризация спецификации
      • Канареечный релиз
      • Ограничение скорости обработки запросов
      • Замена кода ответа
      • Преобразование тела ответа и запроса
    • Квоты и лимиты
  • Управление доступом
  • Правила тарификации
  • Справочник Terraform
  • Метрики Monitoring
  • Аудитные логи Audit Trails
  • История изменений
  • Вопросы и ответы
  • Обучающие курсы

В этой статье:

  • Поддерживаемые параметры
  • Спецификация расширения
  • Примеры использования
  1. Концепции
  2. Расширения спецификации
  3. Интеграции
  4. Статический ответ

Расширение x-yc-apigateway-integration:dummy

Статья создана
Yandex Cloud
Обновлена 2 апреля 2025 г.
  • Поддерживаемые параметры
  • Спецификация расширения
  • Примеры использования

Расширение x-yc-apigateway-integration:dummy возвращает фиксированное содержимое с указанным кодом ответа и необходимыми заголовками без участия стороннего сервиса.

Добавить расширение в спецификацию можно с помощью конструктора спецификаций.

Поддерживаемые параметрыПоддерживаемые параметры

В таблице ниже перечислены параметры, специфичные для API-шлюза сервиса API Gateway. Описание остальных параметров читайте в спецификации OpenAPI 3.0.

Параметр Тип Описание
http_code int Код HTTP-ответа.
http_headers map[string](string|[]string) Список заголовков, которые будут отправлены в ответ. В http_headers осуществляется подстановка параметров.
content map[string]string Данные, которые будут отправлены в ответ.
Могут быть как фактическим содержимым, так и отображением из запрошенного Content-Type в данные. Это позволяет отдавать ошибки в запрошенном формате — JSON или XML. Для значения по умолчанию используется ключ *. В content осуществляется подстановка параметров.

Спецификация расширенияСпецификация расширения

Пример спецификации:

x-yc-apigateway-integration:
  type: dummy
  http_code: 302
  http_headers:
    Location: "/some/location"
    Set-Cookie: ["a={number}", "b=2"]
  content:
    "application/json": "{ \"message\": \"You've been redirected.\" }"

Особенности расширения:

  • Если в запросе есть заголовок Accept:
    • Сначала выбирается лучшее соответствие.
    • Если соответствия нет, то выбирается ключ *.
    • Если ключа нет, то возвращается ответ 415 Media not supported.
  • Если заголовка Accept нет, то выбирается произвольный вариант ответа.
  • Если вариант контента выбран по ключу *, то Content-Type ответа будет выбран из http_headers. Если он там не указан, возвращается фактический Content-Type.

Примеры использованияПримеры использования

  • Защита API Gateway при помощи интеграции с Smart Web Security
  • Работа с API-шлюзом по протоколу WebSocket
  • Как создать чат-бот для Slack

Была ли статья полезна?

Предыдущая
Обзор
Следующая
Обращение по HTTP
Проект Яндекса
© 2025 ООО «Яндекс.Облако»