В рамках быстрого старта рассмотрен пример создания и настройки шлюза API с помощью сервиса API Gateway. Шлюз включает правила, использующие общий и частный бэкенды. Каждое правило обогащено политикой.
В личном кабинете перейдите в раздел Разработка → API Gateway.
В меню слева выберите Shared.
Нажмите Создать шлюз.
Отобразится окно создания шлюза.
По умолчанию шлюзу назначается системный адрес вида <uuid>.apigw.cloud.ru, где uuid — это идентификатор шлюза. Запросы, отправленные на этот адрес, будут обработаны шлюзом. Системный адрес не может быть удален.
Укажите название шлюза.
Выберите шаблон шлюза Обратный прокси.
Шаблон представляет собой набор полей для добавления правил и бэкендов для шлюза. Шаблон Обратный прокси предназначен для трансляции клиентских запросов, направленных на публичный хост. Запросы транслируются на бэкенды (адреса сервисов), скрытые от клиента.
В дальнейшем вы сможете добавить дополнительные правила и бэкенды в шлюз независимо от выбранного шаблона.
Нажмите Продолжить.
Задайте URI для проксирования.
Пример:
Системный адрес: https://bc8296eda9dc4f2ba3a301ac411a32d8.apigw.cloud.ru
URI для проксирования: /service1
Для отправки запросов к бэкенду через шлюз будет использоваться адрес https://bc8296eda9dc4f2ba3a301ac411a32d8.apigw.cloud.ru/service1.
Выберите карточку Общий.
Нажмите Создать общий бэкенд.
Общий бэкенд — доступен всем шлюзам внутри проекта для Shared API.
В соседней вкладке откроется мастер создания бэкенда.
Задайте обязательные параметры бэкенда.
Название — пользовательское название бэкенда. Используется для указания точки маршрутизации запросов.
Протокол — протокол, по которому осуществляется подключение к узлам бэкенда.
Адрес — доменное имя узла бэкенда или IP-адрес бэкенда.
Нажмите Создать.
Общий бэкенд появится в списке Общий бэкенд в мастере создания шлюза.
Выберите созданный общий бэкенд.
Нажмите Продолжить.
Автоматически будет создано правило с указанным URI для проксирования.
В мастере создания шлюза по умолчанию добавляется одно правило. После создания шлюза вы сможете добавить любое количество правил. Каждое правило описывает требования к обработке запросов, направленных на определенные пути в рамках шлюза. Каждому правилу можно подключить политики — дополнительные настройки, модифицирующие правила обработки запросов по URI для проксирования.
Нажмите Добавить политику.
Добавление политики состоит из шагов:
Окно Добавление политики.
Выберите политику, например — «Ограничение запросов».
Заполнение параметров политики:
Количество запросов — оставьте значение по умолчанию.
Интервал времени, сек — оставьте значение по умолчанию.
Нажмите Создать.
Будет создан шлюз с одним активным правилом и политикой «Ограничение запросов».
Запросы по указанным HTTP-методам, направленные на адрес шлюза по заданным URI для проксирования, будут перенаправлены на общий бэкенд. К запросам будет применена политика ограничения запросов.
Для вызова используйте метод (например, «GET») и URL созданного API-шлюза, например — https://bc8296eda9dc4f2ba3a301ac411a32d8.apigw.cloud.ru/service1.
Вы можете просмотреть созданный общий бэкенд в Shared → Общие бэкенды.
В разделе Shared → Шлюзы выберите созданный шлюз.
Откройте Правила и добавьте правило с частным бэкендом.
Частный бэкенд будет использоваться только этим правилом и будет недоступен другим правилам и шлюзам.
Создание правила состоит из шагов:
Основные параметры.
Укажите Название правила.
Задайте параметры правила:
HTTP-метод — методы, запросы по которым будут обработаны данным правилом.
URI для проксирования, запросы на которые будут обработаны данным правилом.
Поддерживаются Wildcard-символы (*) для замещения любой части URI. Например, /route1.
Нажмите Продолжить.
Настройки.
Выберите Частный бэкенд и укажите обязательные параметры бэкенда:
Название — пользовательское название бэкенда. Используется для указания точки маршрутизации запросов.
Тип бэкенда – выберите Стандартный бэкенд и укажите URL-адрес или IP-адрес.
При необходимости укажите порт. По умолчанию используется порт 80 для HTTP / gRPC-трафика и порт 443 для HTTPS / gRPCs-трафика.
Протокол — протокол, по которому осуществляется подключение к узлам бэкенда.
Адрес — доменное имя узла бэкенда или IP-адрес бэкенда.
Нажмите Продолжить.
Политики.
Нажмите Добавить политику.
Добавление политики состоит из шагов:
Окно Добавление политики.
Выберите политику, например — «Кэширование запросов».
Заполнение параметров политики:
Перечень кодов ответа — коды состояния HTTP-ответа, для которых кэшируются ответы.
Оставьте значение по умолчанию.
Интервал времени, сек — время, в течение которого хранится кэш.
Оставьте значение по умолчанию.
Нажмите Создать.
Созданное правило появится в разделе Правила карточки шлюза. Правило сразу активно.
После публикации правила запросы по указанным HTTP-методам, направленные на адрес шлюза по заданному URI для проксирования, будут перенаправлены на частный бэкенд.
К запросам будет применяться политика кэширования запросов.
Для вызова используйте метод (например, «GET») и URL созданного API-шлюза, например — https://bc8296eda9dc4f2ba3a301ac411a32d8.apigw.cloud.ru/route1.