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, oltre ai link a ulteriori informazioni.

Le API sono punti di ingresso affinché un'applicazione utilizzi le funzionalità di un'altra. Implementi i proxy API per creare le API

In Apigee, implementi i proxy API configurando la logica del proxy API come una sequenza di passaggi eseguiti in risposta a una richiesta dal codice client. Puoi 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 su API e 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, 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 fornisce posizioni in cui applicare logica e comportamento in luoghi specifici 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 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 intendi estendere un proxy API con un linguaggio procedurale come Java, JavaScript o Python.

Queste variabili sono conservate da Apigee. Alcuni esistono per impostazione predefinita, in genere perché sono comuni alle operazioni dei proxy API (ad esempio perché fanno parte di una richiesta HTTP). Puoi anche creare variabili personalizzate 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

Proprio 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 API, a cui puoi accedere tramite variabili di flusso. Ad esempio, puoi avere una condizione che controlla lo user agent e quindi elaborare la richiesta di conseguenza.

Per saperne di più sull'esecuzione condizionale, consulta 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 è pacchettizzata come criteri. Un criterio è un componente Apigee 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 ulteriori informazioni sulle norme, consulta l'articolo Che cos'è un criterio?.

Puoi includere insiemi riutilizzabili di funzionalità

Se 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, consulta Flussi condivisi riutilizzabili. Per saperne di più sul concatenamento dei proxy API, consulta la pagina relativa all'unione dei 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 presenta visivamente ogni passaggio del proxy API che viene 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 lo strumento, consulta Strumento di debug.

Gestisci gli errori del proxy API come errori

Configurando un gestore degli errori, puoi personalizzare l'errore restituito a un client API. I gestori di errori ti consentono di controllare i messaggi di errore se questi derivano dal tuo codice o da un componente incluso (ad esempio un criterio).

Per saperne di più, consulta la sezione Gestione degli errori.