Punti chiave dello sviluppo di proxy API

Questa pagina si applica a Apigee e Apigee ibridi.

Visualizza documentazione di Apigee Edge.

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

Le API sono punti di ingresso tramite i quali un'applicazione può utilizzare le funzionalità di un'altra. Implementi l'API per creare API

In Apigee, implementi i proxy API configurando la logica del proxy API come una sequenza di passaggi eseguiti in risposta a una richiesta da parte del codice client. Esponi un proxy API ai client definendo endpoint che includono un URL con percorsi delle risorse, un verbo HTTP, requisiti del corpo e così via.

Anche se è chiamato proxy API, dal punto di vista del codice client, è il tramite Google Cloud.

Per una panoramica dei proxy API, consulta la pagina Informazioni su API e API proxy.

Sei tu a organizzare la sequenza del proxy API la logica utilizzando i flussi

In qualsiasi applicazione, i dati passano attraverso l'applicazione guidata dalla logica di condizione. In Apigee, il percorso di elaborazione è costituito da flussi. Un flusso è una sequenza di fasi (o "passi") che costituiscono il percorso di elaborazione di un proxy API. I flussi sono il modo in cui Apigee ti fornisce luoghi applicare logica e comportamento in punti specifici dal client alla risorsa di backend, quindi di alto profilo.

Per ulteriori informazioni sui flussi, consulta Controllo l'esecuzione di un proxy con i flussi

Puoi accedere ai dati sullo stato tramite variabili di flusso create da proxy API

Un proxy API ha accesso alle variabili che rappresentano lo stato di esecuzione. Puoi accedere a questi dal file XML che configura i proxy e i criteri API. Puoi anche accedervi quando si estende un proxy API con un linguaggio procedurale come Java, JavaScript come Python.

Queste variabili sono conservate da Apigee. Alcune esistono per impostazione predefinita, di solito perché sono comuni a cosa fanno i proxy API (ad esempio perché fanno parte di una richiesta HTTP). Puoi anche creare le tue stesse variabili per soddisfare un requisito logico.

Per ulteriori informazioni sulle variabili, consulta Gestione dello stato del proxy con il flusso variabili.

Puoi fare in modo che i proxy API eseguano 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 le variabili di flusso. Per Ad esempio, puoi avere una condizione che controlla lo user agent, quindi elabora la richiesta di conseguenza.

Per ulteriori informazioni sull'esecuzione condizionale, consulta Condizioni con variabili di flusso.

Puoi implementare la maggior parte della logica in un proxy API utilizzo dei criteri

La maggior parte della logica aggiunta a un proxy API è pacchettizzata come criteri. Un criterio è un modello Apigee componente che incapsula la logica per un'area funzionale, come la sicurezza o la gestione del traffico. Puoi configurare un criterio con XML che imposti le proprietà per la logica sottostante. Sei tu a organizzare norme in una sequenza di "passaggi" all'interno di un flusso, in modo che il proxy API esegua la logica nel nel miglior modo possibile per gli obiettivi del proxy.

Per ulteriori informazioni sulle norme, vedi Che cos'è una norma?.

Puoi includere insiemi riutilizzabili di funzionalità

Quando il proxy API include una logica che verrà utilizzata da più posizioni nel codice, ad esempio come 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 i duplicati attraverso i proxy API.

Per ulteriori informazioni sui flussi condivisi, consulta Riutilizzabile di flussi di dati condivisi. Per saperne di più sul concatenamento dei proxy API, consulta Chaining dei proxy API insieme.

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

Apigee include uno strumento di debug che puoi utilizzare per esaminare l'esecuzione del proxy API flusso quando debug e test. Lo strumento presenta visivamente ogni passaggio del proxy API eseguito per richiesta. Come in un debugger, in ogni passaggio puoi visualizzare l'elenco dei valori delle variabili che compongono l'API lo stato del proxy.

Per ulteriori informazioni sul debug con lo strumento di debug, vedi 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. Guasto consentono di controllare i messaggi di errore, indipendentemente dal fatto che l'errore provenga dal tuo codice oppure da un componente incluso (come una norma).

Per ulteriori informazioni, vedi Gestione di errore.