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

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

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

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

Антипаттерн

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

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

Влияние

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

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

Передовая практика

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

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

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

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

Дополнительная информация