Stai visualizzando la documentazione di Apigee Edge.
Vai alla
documentazione di Apigee X. informazioni
In questo argomento sono elencate alcune caratteristiche di base dei proxy API, insieme ai link a ulteriori informazioni.
Le API sono punti di ingresso che consentono a un'applicazione di utilizzare le funzionalità di un'altra. Devi implementare i proxy API per creare le API
In Apigee Edge, implementerai i proxy API configurando la logica del proxy API come una sequenza di passaggi eseguiti in risposta a una richiesta da codice client. Per esporre un proxy API ai client, definisci endpoint che includono un URL con percorsi delle risorse, un verbo HTTP, requisiti del corpo e così via.
Anche se viene chiamato proxy API, dal punto di vista del codice client è l'API.
Per una panoramica dei proxy API, consulta la pagina Informazioni sulle API e sui proxy API.
Puoi organizzare la sequenza della logica del proxy API utilizzando i flussi
In qualsiasi applicazione, i dati passano attraverso l'applicazione guidati dalla logica delle condizioni. In Apigee Edge, il percorso di elaborazione è composto da flussi. Un flusso è una sequenza di fasi (o "passaggi") che compongono il percorso di elaborazione di un proxy API. I flussi sono il modo in cui Apigee Edge fornisce le posizioni in cui applicare logica e comportamento in posizioni specifiche, dal client alla risorsa di backend, quindi di nuovo al client.
Per saperne di più sui flussi, consulta Controllo dell'esecuzione di un proxy con i flussi
Puoi accedere ai dati di stato tramite le variabili di flusso create dai proxy API
Un proxy API ha accesso alle variabili che rappresentano lo stato di esecuzione. Puoi accedere a queste variabili dal file XML che configura i proxy e i criteri dell'API. Puoi accedervi anche quando estendi un proxy API con un linguaggio procedurale, come Java, JavaScript o Python.
Queste variabili sono gestite da Apigee Edge. Alcuni esistono per impostazione predefinita, di solito perché sono comuni alle funzionalità dei proxy API (ad esempio perché fanno parte di una richiesta HTTP). Puoi anche creare le tue variabili per soddisfare un requisito logico.
Per ulteriori informazioni sulle variabili, consulta Gestione dello stato del proxy con le variabili di flusso.
Puoi fare in modo che i proxy API vengano eseguiti in modo condizionale
Come nella maggior parte dei linguaggi di programmazione, nei proxy API puoi fare in modo che il codice venga eseguito in modo condizionale. Le condizioni si basano spesso sullo stato del proxy dell'API, a cui puoi accedere tramite le variabili di flusso. Ad esempio, puoi avere una condizione che controlla lo user agent e poi elabora la richiesta di conseguenza.
Per saperne di più sull'esecuzione condizionale, consulta Variabili e condizioni di flusso.
Implementi la maggior parte della logica in un proxy API utilizzando i criteri
La maggior parte della logica che aggiungi a un proxy API è pacchettizzata come criteri. Un criterio è un componente Apigee Edge che incapsula la logica per un'area funzionale, come la sicurezza o la gestione del traffico. Configuri un criterio con XML che imposti le proprietà per la logica sottostante. Disponi i criteri in una sequenza di "passaggi" all'interno di un flusso, in modo che il proxy API esegua la logica nell'ordine migliore per gli obiettivi del proxy.
Per ulteriori informazioni sulle norme, consulta l'articolo Che cos'è un criterio?.
Puoi includere insiemi di funzionalità riutilizzabili
Se il tuo proxy API include logica che verrà utilizzata da più posizioni nel codice, ad esempio altri proxy API, puoi raccogliere tale logica per le chiamate da più posizioni. Ad esempio, puoi raggruppare la logica di sicurezza in un flusso condiviso chiamato da altri proxy API, riducendo la duplicazione tra i proxy API.
Per saperne di più sui flussi condivisi, consulta Flussi condivisi riutilizzabili. Per saperne di più sul concatenamento dei proxy API, consulta la pagina relativa a come utilizzare insieme i proxy API.
Puoi eseguire il debug di un proxy con lo strumento Trace
Apigee Edge include uno strumento Trace che puoi utilizzare per esaminare il flusso di esecuzione del proxy API durante il debug e il test. Lo strumento presenta visivamente ogni passaggio del proxy API eseguito per una richiesta. Come in un debugger, in ogni passaggio puoi visualizzare l'elenco dei valori delle variabili che compongono lo stato del proxy API.
Per ulteriori informazioni sul debug con Trace, consulta la sezione Utilizzo dello strumento Trace.
Gestisci gli errori del proxy API come errori
Configurando un gestore dei guasti, puoi personalizzare l'errore restituito a un client API. I gestori degli errori ti consentono di controllare i messaggi di errore indipendentemente dal fatto che l'errore provenga dal tuo codice o da un componente incluso (come un criterio).
Per scoprire di più, consulta la sezione Gestione degli errori.