Быстрый старт

В рамках быстрого старта рассмотрен пример создания и настройки шлюза API с помощью сервиса API Gateway. В качестве исходного хоста используется внешний HTTP-ресурс.

  1. Откройте рабочую область API Gateway (Разное → API Gateway).

  2. Нажмите кнопку Создать API-шлюз.

  3. Введите имя и краткое описание шлюза API.

  4. Нажмите кнопку Создать.

    После создания карточка шлюза будет доступна в рабочей области. Шлюзу назначается адрес. Запросы, отправленные на этот адрес, будут обработаны шлюзом. Чтобы скопировать адрес в буфер обмена нажмите кнопку Копировать адрес.

  5. Перейдите в созданный шлюз, нажав карточку шлюза. Вкладка Конфигурация содержит адрес созданного шлюза API.

  6. Откройте вкладку Подключения и нажмите кнопку Создать подключение.

  7. Задайте обязательные параметры подключения.

    • Наименование подключения — пользовательское имя подключения. Используется для указания точки маршрутизации запросов.

    • Протокол — протокол, по которому осуществляется подключение к целевым хостам.

    • Адрес подключения — доменное имя целевого хоста или IP-адрес подключения.

  8. Нажмите кнопку Создать.

  9. Перейдите на вкладку Правила и нажмите кнопку Создать правило.

    Подсказка

    Каждому шлюзу можно назначить произвольное количество правил, которые описывают требования к обработке запросов, направленных на определенные пути в рамках шлюза. Каждому правилу можно задать произвольное количество URI, а также обогатить правило подключением плагинов — дополнительных настроек, модифицирующих правила обработки запросов по данным путям.

    Создание правила состоит из шагов:

    1. Выбор правила.

      • Укажите Название правила.

      • Выберите Тип правила, например — «Маршрутизация запросов». Тип правила определяет основные функциональные возможности правила.

      Нажмите кнопку Продолжить.

    2. Параметры правила.

      Набор параметров параметров зависит от выбранного типа, при следовании быстрому старту будут доступны следующие настройки:

      • HTTP-методы — методы, запросы по которым будут обработаны данным правилом.

      • Подключение, содержащее целевой хост, на который будут перенаправлены запросы.

      • URI бэкенда, на который будут перенаправлены запросы.

      • Список URI для proxy, запросы на которые будут обработаны данным правилом. Поддерживаются Wildcard-символ (*) для замещения любой части URI.

      Нажмите кнопку Продолжить.

    3. Настройка плагинов.

      В рамках быстрого старта этот опциональный шаг пропускается.

      Нажмите кнопку Создать.

    Созданное правило появится в разделе Правила.

  10. Активируйте правило, нажав на переключатель в разделе Статус.

После публикации правила запросы по указанным HTTP-методам, направленные на адрес шлюза по заданным URI, будут перенаправлены на целевой хост. При необходимости можно создать дополнительные правила для расширения логики работы API шлюза.

Для вызова используйте метод (например, «GET») и URL созданного API, например — https://bc8296eda9dc4f2ba3a301ac411a32d8.apigw.sbercloud.ru/route1.