Yandex Cloud
  • Сервисы
  • Решения
  • Почему Yandex Cloud
  • Сообщество
  • Тарифы
  • Документация
  • Связаться с нами
Подключиться
Language / Region
© 2022 ООО «Яндекс.Облако»
Yandex API Gateway
  • Начало работы
  • Пошаговые инструкции
    • Все инструкции
    • Создание API-шлюза
    • Изменение API-шлюза и его спецификации
    • Подключение домена
    • Удаление API-шлюза
    • Мониторинг
    • Просмотр журнала выполнения
  • Практические руководства
    • Развертывание веб-приложения
    • Разработка навыка Алисы и сайта с авторизацией
    • Разработка Slack-бота
    • Разработка Telegram-бота
  • Концепции
    • Взаимосвязь ресурсов сервиса
    • Расширения спецификации
      • Обзор
      • Статический ответ
      • Вызов функции
      • Интеграция с Serverless Containers
      • Обращение по HTTP
      • Интеграция с Object Storage
      • Интеграция с DataSphere
      • Интеграция с Data Streams
      • Интеграция с Message Queue
      • Жадные параметры
      • Обобщенный HTTP-метод
      • Авторизация с помощью функции
    • Квоты и лимиты
  • Управление доступом
  • Правила тарификации
  • Справочник API
    • Аутентификация в API
    • gRPC (англ.)
      • Overview
      • ApiGatewayService
      • OperationService
    • REST (англ.)
      • Overview
      • ApiGateway
        • Overview
        • addDomain
        • create
        • delete
        • get
        • getOpenapiSpec
        • list
        • listAccessBindings
        • listOperations
        • removeDomain
        • setAccessBindings
        • update
        • updateAccessBindings
  • Вопросы и ответы
  1. Концепции
  2. Расширения спецификации
  3. Обзор

Обзор

Статья создана
Yandex Cloud
,
улучшена
Evgeniy V.
  • Расширение x-yc-apigateway
    • Поддерживаемые параметры
    • Спецификация расширения
  • Расширение x-yc-apigateway-integration
    • Поддерживаемые параметры
    • Спецификация расширения

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

Расширение x-yc-apigateway позволяет задать верхнеуровневые параметры API-шлюза, значения которых будут наследоваться вложенными расширениями.

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

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

Параметр Тип Описание
service_account_id string Идентификатор сервисного аккаунта, от имени которого API-шлюз будет выполнять операции.

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

x-yc-apigateway:
  service_account_id: <ID сервисного аккаунта>

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

Расширение x-yc-apigateway-integration — это точка входа для интеграции API-шлюза с другими сервисами.

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

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

Параметр Тип Описание
type string Тип расширения. Доступные значения: dummy, cloud_functions, http, object_storage, cloud_datasphere, cloud_datastreams и serverless_containers.

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

<Запрос>:
  <Метод>:
    x-yc-apigateway-integration:
      type: <Тип>
      <Список параметров в виде пары ключ: значение>

Содержимое расширения меняется в зависимости от указанного типа (type) в блоке x-yc-apigateway-integration:

  • dummy — возвращает фиксированное содержимое с указанным кодом ответа и необходимыми заголовками без участия стороннего сервиса.
  • cloud_functions — вызывает указанную функцию, передавая ей на вход информацию об HTTP-запросе, и возвращает клиенту результат выполнения этой функции.
  • http — перенаправляет запрос в указанный URL.
  • object_storage — передает обработку запроса в Object Storage с целью раздачи статических файлов.
  • cloud_datasphere — вызывает указанную ноду DataSphere, передавая ей тело запроса со значениями входных переменных, и возвращает результат выполнения ноды в теле ответа.
  • cloud_datastreams — обращается к Yandex Data Streams для выполнения операции с указанным потоком.
  • serverless_containers — перенаправляет запрос в указанный контейнер.
  • cloud_ymq — обращается к Yandex Message Queue для выполнения операции с указанной очередью.

Все типы поддерживают подстановку параметров — замену всех ключей на соответствующее значение. Ключ должен быть определен как параметр соответствующей операции (допускаются все типы параметров, определенные в OpenAPI-Specification — path, query, header, cookie).
Подстановка параметров производится только в некоторых значениях, в зависимости от типа расширения.

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

Language / Region
© 2022 ООО «Яндекс.Облако»
В этой статье:
  • Расширение x-yc-apigateway
  • Поддерживаемые параметры
  • Спецификация расширения
  • Расширение x-yc-apigateway-integration
  • Поддерживаемые параметры
  • Спецификация расширения