Antipattern: definisci più ProxyEndpoint in un proxy API

Stai visualizzando la documentazione relativa a Apigee e Apigee ibrido.
Visualizza Documentazione di Apigee Edge.

La configurazione di ProxyEndpoint definisce il modo in cui le app client utilizzano le API tramite Apigee. ProxyEndpoint definisce l'URL del proxy API e il comportamento di un proxy: quali criteri applicare e gli endpoint target da instradare, nonché le condizioni che devono essere soddisfatte per questi criteri di route da eseguire.

In breve, la configurazione ProxyEndpoint definisce tutto ciò che è necessario fare per implementare tramite Google Cloud CLI o tramite l'API Compute Engine.

Antipattern

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

D'altra parte, quando si definiscono più ProxyEndpoint in un singolo proxy API, si finisce combinando concettualmente molte API non correlate in un unico artefatto. Rende più difficili i proxy API per leggere, comprendere, eseguire il debug e gestire. Questo sconfigge la filosofia principale dei proxy API: rendere per gli sviluppatori la creazione e la manutenzione delle API.

Impatto

Più ProxyEndpoint in un proxy API possono:

  • Rendere difficile per gli sviluppatori comprendere e gestire il proxy API.
  • Offuscare l'analisi. Per impostazione predefinita, i dati di analisi vengono aggregati a livello di proxy. Non sono presenti Analisi dettagliata delle metriche per endpoint proxy, a meno che non crei report personalizzati.
  • Semplifica la risoluzione dei problemi relativi ai proxy API.

Best practice

Quando implementi un nuovo proxy API o riprogetta un proxy API esistente, utilizza la seguenti best practice:

  1. Implementare un proxy API con un singolo ProxyEndpoint.
  2. Se esistono più API che condividono un server di destinazione comune e/o richiedono la stessa logica o dopo la chiamata al server di destinazione, valuta la possibilità di utilizzare flussi condivisi per implementare questa logica da proxy API diversi.
  3. Se esistono più API che condividono un percorso di base iniziale comune, ma il suffisso è diverso, utilizzare flussi condizionali in un singolo ProxyEndpoint.
  4. Se esiste un proxy API con più ProxyEndpoint e se non presenta problemi, non devi fare nulla.

L'utilizzo di un ProxyEndpoint per proxy API porta a:

  1. Proxy più semplici e facili da gestire
  2. Analytics fornisce migliori informazioni, come le prestazioni proxy e il tempo di risposta target, riportati separatamente invece che raggruppati per tutti i ProxyEndpoint
  3. Risoluzione dei problemi e risoluzione dei problemi più rapide

Per approfondire