Antywzór: definiowanie wielu punktów ProxyEndpoint w serwerze proxy interfejsu API

Przeglądasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. Informacje

Konfiguracja ProxyEndpoint określa sposób korzystania przez aplikacje klienckie z interfejsów API przez Apigee Edge. ProxyEndpoint określa adres URL serwera proxy interfejsu API i jego zachowanie: które zasady należy zastosować, do których docelowych punktów końcowych należy skierować ruch oraz warunki, które muszą zostać spełnione, aby te zasady lub reguły były wykonywane.

Krótko mówiąc, konfiguracja ProxyEndpoint określa wszystko, co jest potrzebne do wdrożenia interfejsu API.

Antywzór

Serwer proxy interfejsu API może mieć 1 lub więcej punktów końcowych serwera proxy. Definiowanie wielu punktów ProxyEndpoints to prosty mechanizm wdrażania wielu interfejsów API w jednym serwerze proxy. Pozwala to ponownie używać zasad lub logiki biznesowej przed wywołaniem elementu TargetEndpoint i po nim.

Z drugiej strony definiowanie wielu punktów ProxyEndpoint w jednym serwerze proxy interfejsu API kończy się koncepcją połączenia wielu niepowiązanych interfejsów API w 1 artefakt. Utrudnia to odczytywanie, analizowanie, debugowanie i utrzymywanie serwerów proxy API. Przekształca to główną filozofię serwerów proxy interfejsów API: ułatwianie programistom tworzenie i utrzymywanie interfejsów API.

Wpływ

Wiele punktów ProxyEndpoints na serwerze proxy interfejsu API może:

  • Utrudnij deweloperom zrozumienie i obsługę serwera proxy interfejsu API.
  • Ukrywanie statystyk. Domyślnie dane analityczne są agregowane na poziomie serwera proxy. Wskaźniki według punktu końcowego serwera proxy nie są podzielone według punktu końcowego serwera proxy, chyba że utworzysz raporty niestandardowe.
  • Utrudnij rozwiązywanie problemów z serwerami proxy interfejsów API.

Sprawdzona metoda

Podczas wdrażania nowego serwera proxy interfejsu API lub projektowania istniejącego serwera proxy interfejsu API postępuj zgodnie z tymi sprawdzonymi metodami:

  1. Wdróż jeden serwer proxy interfejsu API z pojedynczym punktem ProxyEndpoint.
  2. Jeśli jest wiele interfejsów API, które mają wspólny serwer docelowy lub wymagają takiej samej logiki przed wywołaniem bądź po jego wywołaniu, rozważ użycie wspólnych przepływów w celu zaimplementowania takiej logiki na różnych serwerach proxy API.
  3. Jeśli jest wiele interfejsów API, które mają wspólną początkową ścieżkę podstawową, ale różnią się sufiksem, użyj przepływów warunkowych w jednym punkcie ProxyEndpoint.
  4. Jeśli istnieje serwer proxy interfejsu API z wieloma punktami ProxyEndpoints i nie ma z nim żadnych problemów, nie musisz nic robić.

Użycie 1 punktu ProxyEndpoint na każdy serwer proxy interfejsu API prowadzi do:

  1. Łatwiejsze w obsłudze serwery proxy
  2. Lepsze informacje w Analytics, takie jak wydajność serwera proxy i docelowy czas odpowiedzi, będą raportowane oddzielnie, a nie zebrane dla wszystkich punktów ProxyEndpoints
  3. Szybsze rozwiązywanie problemów

Więcej informacji