INTEGRITY Документация

API Routing

API Shield Routing позволяет предоставить единый внешний API, который направляет запросы к разным бэкенд-сервисам, даже если эти сервисы используют другие пути или хосты, чем ваша зона.

Процесс

Source Endpoints необходимо добавлять в Endpoint Management установленными способами, включая загрузка схемы, через API Discovery, или с помощью добавление вручную, перед созданием маршрута.

Чтобы создать route, потребуется operation ID исходной конечной точки (Source Endpoint). Чтобы найти operation ID в панели управления:

  1. На панели управления Cloudflare перейдите к разделу Web Assets страницу.

    Перейдите в Web assets ↗
  2. Отфильтруйте эндпоинты, чтобы найти свой Source Endpoint.

  3. Разверните строку для вашего Source Endpoint и запишите ID операции поле.

  4. Выберите значок копирования, чтобы скопировать ID операции в буфер обмена.

Когда ваши Source Endpoints будут добавлены в Endpoint Management, выполните следующие шаги, чтобы создать и проверить маршруты для любого operation ID:

Создание маршрута

  1. На панели управления Cloudflare перейдите к разделу Web Assets страницу.

    Перейдите в Web assets ↗
  2. В Конечные точки, выберите существующую конечную точку и разверните её сведения.

  3. В разделе Маршрутизация, выберите Создать маршрут.

  4. Введите целевой URL-адрес или IP-адрес, на который будет направляться ваш эндпоинт.

  5. Выберите Развернуть маршрут.

Вы также можете изменить или удалить маршрут, выбрав Измените маршрут для существующего маршрута.

Test a route

После отправки запроса на Source Endpoint вы должны увидеть содержимое серверной части так, как если бы вы обратились напрямую к Target Endpoint.

Если API Shield возвращает неожиданные результаты, проверьте узел, метод и путь исходной конечной точки, а также проверить Route чтобы убедиться в правильности значения Target Endpoint.

Доступность

API Shield Routing сейчас доступен в открытой бета-версии только клиентам плана Enterprise, оформившим подписку на API Shield. Клиенты плана Enterprise, у которых нет подписки на API Shield, могут ознакомиться с API Shield как услуга без контракта ↗ в панели управления Cloudflare или обратившись в свою команду по работе с клиентами.

Ограничения

Target Endpoint нельзя направить на Worker, если маршрут ведёт в ту же зону.

Метод запроса нельзя изменить. Например, GET Source Endpoint всегда отправляет GET запрос к Target Endpoint.

В Target Endpoint необходимо использовать все переменные, которые есть в Source Endpoint. Например, маршрутизация /api/{var1}/users/{var2} к /api/users/{var2} не допускается и приведёт к ошибке, поскольку {var1} присутствует в Source Endpoint, но отсутствует в Target Endpoint.