Anti-pattern: definisci più ProxyEndpoint in un proxy API

Stai visualizzando la documentazione di Apigee Edge.
Vai alla documentazione di Apigee X.
informazioni

La configurazione ProxyEndpoint definisce il modo in cui le app client utilizzano le API tramite Apigee Edge. ProxyEndpoint definisce l'URL del proxy API e il comportamento di quest'ultimo: i criteri da applicare e gli endpoint di destinazione verso cui eseguire il routing e le condizioni che devono essere soddisfatte per l'esecuzione di questi criteri o di regole di routing.

In breve, la configurazione ProxyEndpoint definisce tutto ciò che è necessario fare per implementare un'API.

Antipattern

Un proxy API può avere uno o più endpoint proxy. La definizione di più ProxyEndpoint è un meccanismo semplice e semplice per implementare più API in un unico proxy. Ciò consente di riutilizzare i criteri e/o la logica di business prima e dopo la chiamata a TargetEndpoint.

D'altra parte, quando definisci più ProxyEndpoint in un singolo proxy API, si combina concettualmente molte API non correlate in un unico artefatto. Rende i proxy API più difficili da leggere, comprendere, sottoporre a debug e gestire. In questo modo è possibile violare la filosofia principale dei proxy API: semplificare la creazione e la gestione delle API per gli sviluppatori.

Impatto

Più ProxyEndpoint in un proxy API possono:

  • Rendi difficile per gli sviluppatori comprendere e gestire il proxy API.
  • Offusca l'analisi. Per impostazione predefinita, i dati di analisi vengono aggregati a livello di proxy. Non è prevista una suddivisione delle metriche per endpoint proxy, a meno che non crei report personalizzati.
  • Rendi difficile la risoluzione dei problemi relativi ai proxy API.

Best practice

Quando implementi un nuovo proxy API o riprogetta un proxy API esistente, attieniti alle seguenti best practice:

  1. Implementa un proxy API con un singolo ProxyEndpoint.
  2. Se sono presenti più API che condividono un server di destinazione comune e/o richiedono la stessa logica prima o dopo la chiamata del server di destinazione, valuta la possibilità di utilizzare flussi condivisi per implementare questa logica in diversi proxy API.
  3. Se sono presenti più API che condividono un percorso di base iniziale comune, ma differiscono nel suffisso, utilizza i flussi condizionali in un singolo ProxyEndpoint.
  4. Se esiste un proxy API con più ProxyEndpoint e non si verificano problemi, non è necessaria alcuna azione da parte tua.

L'utilizzo di un ProxyEndpoint per proxy API genera:

  1. Proxy più semplici e facili da gestire
  2. Le migliori informazioni in Analytics, come le prestazioni del proxy e i tempi di risposta target, verranno riportate separatamente anziché raggruppate per tutti i ProxyEndpoint
  3. Risoluzione più rapida dei problemi

Per approfondire