Stai visualizzando la documentazione di Apigee Edge.
Consulta la
documentazione di Apigee X. info
Questo argomento elenca alcune caratteristiche di base dei proxy API, insieme ai link per ulteriori informazioni.
Le API sono punti di ingresso per un'applicazione che utilizza le funzionalità di un'altra. Implementi i proxy API per creare API
In Apigee Edge, implementi i proxy API configurando la logica del proxy API come una sequenza di passaggi che vengono eseguiti in risposta a una richiesta dal codice client. Esporre un proxy API ai client definendo endpoint che includono un URL con percorsi delle risorse, un verbo HTTP, requisiti del corpo, e così via.
Sebbene si chiami proxy API, dal punto di vista del codice client, è l'API.
Per una panoramica dei proxy API, consulta Informazioni sulle API e sui proxy.
Disponi la sequenza della logica del proxy API utilizzando i flussi
In qualsiasi applicazione, i dati scorrono attraverso l'applicazione guidati dalla logica delle condizioni. In Apigee Edge, il percorso di elaborazione è costituito 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 ti consente di applicare la logica e il comportamento in posizioni specifiche dalla risorsa client a quella di backend e poi di nuovo al client.
Per saperne di più sui flussi, consulta Controllare l'esecuzione di un proxy con i flussi
Accedi 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 dall'XML che configura i proxy API e i criteri. Puoi accedervi anche quando estendi un proxy API con un linguaggio procedurale, come Java, JavaScript, o Python.
Queste variabili sono gestite da Apigee Edge. Alcune esistono per impostazione predefinita, di solito perché sono comuni a ciò che fanno i proxy API (ad esempio perché fanno parte di una richiesta HTTP). Puoi anche creare le tue variabili per soddisfare un requisito logico.
Per saperne di più sulle variabili, consulta Gestire lo stato del proxy con le variabili di flusso.
Puoi eseguire i proxy API in modo condizionale
Come nella maggior parte dei linguaggi di programmazione, nei proxy API puoi eseguire il codice in modo condizionale. Le condizioni si basano spesso sullo stato del proxy API, a cui puoi accedere tramite le variabili di flusso. Ad esempio, puoi avere una condizione che controlla lo user agent, quindi elabora la richiesta di conseguenza.
Per saperne di più sull'esecuzione condizionale, consulta Variabili di flusso e condizioni.
Implementi la maggior parte della logica in un proxy API utilizzando i criteri
La maggior parte della logica che aggiungi a un proxy API è inclusa nei criteri. Un criterio è un componente di Apigee Edge che incapsula la logica per un'area funzionale, come la sicurezza o la gestione del traffico. Configuri un criterio con XML che imposta 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 saperne di più sui criteri, consulta Che cos'è un criterio?.
Puoi includere set di funzionalità riutilizzabili
Se il proxy API include una logica che verrà utilizzata da più posizioni nel codice, ad esempio da altri proxy API, puoi raccogliere questa 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 Concatenamento di proxy API insieme.
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, a ogni passaggio puoi visualizzare l'elenco dei valori delle variabili che compongono lo stato del proxy API.
Per saperne di più sul debug con Trace, consulta Utilizzare lo strumento Trace.
Gestisci gli errori del proxy API come errori
Configurando un gestore di errori, puoi personalizzare l'errore restituito a un client API. I gestori di errori ti consentono di controllare i messaggi di errore, indipendentemente dal fatto che l'errore provenga dal tuo codice o da un componente incluso (ad esempio un criterio).
Per saperne di più, consulta Gestire gli errori.