Антипаттерн: определение нескольких ProxyEndpoint в прокси-сервере API

Вы просматриваете документацию по Apigee Edge.
Перейдите к документации по Apigee X.
Информация

Конфигурация ProxyEndpoint определяет, как клиентские приложения используют API через Apigee Edge. ProxyEndpoint определяет URL прокси-сервера API и его поведение: какие правила применять, на какие целевые конечные точки перенаправлять запросы и какие условия должны быть выполнены для выполнения этих правил или правил маршрутизации.

Конфигурация ProxyEndpoint определяет все, что необходимо для реализации API.

Антипаттерн

У прокси-сервера API может быть одна или несколько конечных точек прокси. Определение нескольких ProxyEndpoint – это простой способ реализовать несколько API в одном прокси. Это позволяет повторно использовать правила и/или бизнес-логику до и после вызова TargetEndpoint.

С другой стороны, если вы определите несколько ProxyEndpoint в одном прокси-сервере API, то объедините в один объект несколько не связанных друг с другом API. Это затрудняет чтение, понимание, отладку и обслуживание прокси API. Это противоречит основной идее прокси API: упростить для разработчиков создание и обслуживание API.

Результат

Несколько ProxyEndpoint в прокси-сервере API могут:

  • Разработчикам будет сложно понять и поддерживать прокси-сервер API.
  • Скрыть аналитику. По умолчанию данные статистики агрегируются на уровне прокси-сервера. Разбивка показателей по конечным точкам прокси-сервера отсутствует, если вы не создадите специальные отчеты.
  • Усложняет устранение неполадок с прокси API.

Совет

При создании нового или изменении существующего прокси-сервера API следуйте приведенным ниже рекомендациям.

  1. Реализуйте один прокси-сервер API с одной конечной точкой ProxyEndpoint.
  2. Если несколько API используют один и тот же целевой сервер и/или требуют одинаковой логики до или после вызова целевого сервера, рассмотрите возможность использования общих потоков для реализации такой логики в разных прокси API.
  3. Если несколько API имеют общий базовый путь, но различаются суффиксом, используйте условные потоки в одном ProxyEndpoint.
  4. Если прокси-сервер API с несколькими ProxyEndpoint существует и с ним нет проблем, никаких действий предпринимать не нужно.

Использование одной конечной точки ProxyEndpoint для каждого прокси-сервера API приводит к следующим последствиям:

  1. Более простые и удобные в обслуживании прокси-серверы
  2. Более подробная информация в Аналитике, например об эффективности прокси-сервера и целевом времени ответа, будет показываться отдельно, а не сводиться для всех ProxyEndpoint.
  3. Быстрое устранение неполадок.

Дополнительные материалы