Punti chiave dello sviluppo di proxy API

Stai visualizzando la documentazione di Apigee Edge.
Vai alla documentazione di Apigee X.
info

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

Le API sono punti di contatto che consentono a un'applicazione di utilizzare 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 sequenza di passaggi che vengono eseguiti in risposta a una richiesta del codice client. Esponi un proxy API ai client definendo endpoint che includono un URL con percorsi delle risorse, un verbo HTTP, requisiti per il 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 API.

Organizzi la sequenza della logica del proxy API utilizzando i flussi

In qualsiasi applicazione, i dati fluiscono attraverso l'applicazione in base alla logica delle condizioni. In Apigee Edge, 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 consentono ad Apigee Edge di fornirti punti in cui applicare logica e comportamento in punti specifici dal client alla risorsa di backend e poi di nuovo al client.

Per saperne di più sui flussi, consulta Controllare come viene eseguito un proxy con i flussi.

Accedi ai dati dello 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 detenute da Apigee Edge. Alcuni esistono per impostazione predefinita, in genere 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 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 controlli lo user agent, quindi elabora la richiesta di conseguenza.

Per saperne di più sull'esecuzione condizionale, consulta la sezione Variabili e condizioni.

Implementi la maggior parte della logica in un proxy API utilizzando i criteri

La maggior parte della logica aggiunta a un proxy API è pacchettizzata come criteri. Un criterio è un componente Apigee Edge che incapsula la logica di un'area funzionale, come la sicurezza o la gestione del traffico. Configura un criterio con XML che imposta le proprietà per la logica di base. Ordina 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 insiemi riutilizzabili di funzionalità

Quando il proxy API include una logica che verrà utilizzata da più punti del codice, ad esempio altri proxy API, puoi raccogliere questa logica per le chiamate da più punti. 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 Flui condivisi riutilizzabili. Per saperne di più sul concatenamento dei proxy API, consulta Concatenare i proxy API.

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

Apigee Edge include uno strumento di traccia che puoi utilizzare per esaminare il flusso di esecuzione del proxy API durante il debug e i 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 saperne di più sul debug con Trace, consulta Utilizzare lo strumento Trace.

Gestisci gli errori del proxy API come errori

Configurando un gestore degli errori, 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 (ad esempio un criterio).

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