Yandex.Cloud
  • Сервисы
  • Почему Yandex.Cloud
  • Сообщество
  • Решения
  • Тарифы
  • Документация
  • Связаться с нами
Подключиться
Yandex API Gateway
  • Начало работы
  • Пошаговые инструкции
    • Все инструкции
    • Создание API-шлюза
    • Изменение API-шлюза и его спецификации
    • Подключение домена
    • Удаление API-шлюза
    • Просмотр графика мониторинга
    • Просмотр журнала выполнения
  • Сценарии использования
    • Развертывание веб-приложения
  • Концепции
    • Взаимосвязь ресурсов сервиса
    • Расширения спецификации
      • Обзор
      • Статический ответ
      • Вызов функции
      • Обращение по HTTP
      • Интеграция с Object Storage
      • Жадные параметры
      • Обобщенный HTTP-метод
    • Квоты и лимиты
  • Управление доступом
  • Правила тарификации
  • Справочник API
    • Аутентификация в API
    • gRPC
      • Обзор
      • ApiGatewayService
      • OperationService
    • REST
      • Обзор
      • ApiGateway
        • Обзор
        • create
        • delete
        • get
        • getOpenapiSpec
        • list
        • listAccessBindings
        • listOperations
        • setAccessBindings
        • update
        • updateAccessBindings
  • Вопросы и ответы
  1. Концепции
  2. Расширения спецификации
  3. Статический ответ

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

  • Поддерживаемые параметры
  • Спецификация расширения

Расширение 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.
В этой статье:
  • Поддерживаемые параметры
  • Спецификация расширения
Language / Region
Вакансии
Политика конфиденциальности
Условия использования
Брендбук
© 2021 ООО «Яндекс.Облако»