Punti chiave dello sviluppo di proxy API

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza la documentazione di Apigee Edge.

Questo argomento elenca alcune caratteristiche di base dei proxy API, insieme a link per ulteriori informazioni.

Le API sono punti di accesso per un'applicazione che utilizza le funzionalità di un'altra. Implementi i proxy API per creare API

In Apigee, 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 sia chiamato proxy API, dal punto di vista del codice client, è l'API.

Per una panoramica dei proxy API, consulta Informazioni sulle API e sui proxy API.

Organizzi la sequenza della logica del proxy API utilizzando i flussi

In qualsiasi applicazione, i dati fluiscono attraverso l'applicazione guidati dalla logica delle condizioni. In Apigee, il percorso di elaborazione è costituito da flussi. Un flusso è una sequenza di fasi (o "passaggi") che costituiscono il percorso di elaborazione di un proxy API. I flussi sono il modo in cui Apigee ti offre posizioni specifiche in cui applicare la logica e il comportamento dal client alla risorsa di backend e viceversa.

Per saperne di più sui flussi, vedi 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 a 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. Alcuni 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, vedi Gestire lo 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 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 la sezione Condizioni con variabili 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 viene pacchettizzata come criteri. Un criterio è un componente Apigee che incapsula la logica per un'area funzionale, ad esempio la sicurezza o la gestione del traffico. Configuri un criterio con XML che imposta le proprietà per la logica sottostante. Organizzi le policy 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 riutilizzabili di funzionalità

Quando il proxy API include una logica che verrà utilizzata da più posizioni nel codice, ad esempio 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, vedi Flussi condivisi riutilizzabili. Per saperne di più sul concatenamento dei proxy API, consulta la sezione Concatenamento di proxy API.

Puoi eseguire il debug di un proxy con lo strumento di debug

Apigee include uno strumento di debug che puoi utilizzare per esaminare il flusso di esecuzione del proxy API durante il debug e il test. Lo strumento mostra 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 lo strumento di debug, vedi Strumento di debug.

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 abbia origine dal tuo codice o da un componente incluso (ad esempio un criterio).

Per saperne di più, consulta la sezione Gestione dei guasti.