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

Wyświetlasz dokumentację Apigee Edge.
Przejdź do dokumentacji Apigee X. info

Konfiguracja ProxyEndpoint określa sposób, w jaki aplikacje klienckie korzystają z interfejsów API za pomocą Apigee Edge. ProxyEndpoint określa adres URL proxy interfejsu API oraz sposób jego działania: które zasady mają być stosowane i do których docelowych punktów końcowych ma być kierowany ruch, a także warunki, które muszą zostać spełnione, aby te zasady lub reguły routingu zostały wykonane.

Krótko mówiąc, konfiguracja ProxyEndpoint określa wszystko, co należy zrobić, aby zaimplementować interfejs API.

Antywzorzec

Proxy interfejsu API może mieć co najmniej 1 punkt końcowy proxy. Zdefiniowanie wielu punktów ProxyEndpoints to łatwy i prosty mechanizm implementowania wielu interfejsów API w jednym proxy. Umożliwia to ponowne wykorzystanie zasad lub logiki biznesowej przed i po wywołaniu TargetEndpoint.

Z drugiej strony, gdy definiujesz wiele punktów ProxyEndpoints w jednym proxy interfejsu API, w efekcie łączysz wiele niezwiązanych ze sobą interfejsów API w jeden artefakt. Utrudnia to odczytywanie, zrozumienie, debugowanie i utrzymywanie proxy interfejsów API. Jest to sprzeczne z główną filozofią proxy interfejsów API, która polega na ułatwianiu programistom tworzenia interfejsów API i zarządzania nimi.

Wpływ

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

  • utrudniać programistom zrozumienie i utrzymanie proxy interfejsu API;
  • zaciemniać dane analityczne. Domyślnie dane analityczne są agregowane na poziomie proxy. Nie ma podziału danych według punktu końcowego proxy, chyba że utworzysz raporty niestandardowe.
  • utrudniać rozwiązywanie problemów z proxy interfejsów API.

Sprawdzona metoda

Podczas implementowania nowego proxy interfejsu API lub przeprojektowywania istniejącego proxy interfejsu API stosuj te sprawdzone metody:

  1. Zaimplementuj 1 proxy interfejsu API z 1 punktem ProxyEndpoint.
  2. Jeśli istnieje wiele interfejsów API, które korzystają z tego samego serwera docelowego lub wymagają tej samej logiki przed lub po wywołaniu serwera docelowego, rozważ użycie przepływów współdzielonych, aby zaimplementować taką logikę w różnych proxy interfejsów API.
  3. Jeśli istnieje wiele interfejsów API, które mają wspólną ścieżkę podstawową, ale różnią się sufiksem, użyj przepływów warunkowych w jednym punkcie ProxyEndpoint.
  4. Jeśli istnieje proxy interfejsu API z wieloma punktami ProxyEndpoints i nie ma z nim żadnych problemów, nie musisz podejmować żadnych działań.

Używanie 1 punktu ProxyEndpoint na proxy interfejsu API prowadzi do:

  1. prostszych proxy, które łatwiej utrzymać;
  2. lepszych informacji w Analytics, takich jak skuteczność proxy i czas odpowiedzi serwera docelowego, które będą raportowane oddzielnie, a nie sumowane dla wszystkich punktów ProxyEndpoints;
  3. szybszego rozwiązywania problemów.

Więcej informacji