Questa pagina è stata tradotta dall'API Cloud Translation.

Variabili di richiesta e risposta

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza la documentazione di Apigee Edge.

Quando effettui una richiesta a un proxy API, puoi passare una o tutte le seguenti informazioni, a seconda della modalità di configurazione del proxy API:

Intestazioni delle richieste
Parametri di query
Dati del modulo
Payload XML o JSON
URI risorsa

Per impostazione predefinita, tutti i dati di una richiesta vengono passati senza modifiche da ProxyEndpoint a TargetEndpoint. Di conseguenza, quando TargetEndpoint invia la richiesta al server di backend, tutte le informazioni nella richiesta originale vengono passate al servizio di backend.

Lo stesso vale per la risposta ricevuta da Apigee dal servizio di backend. Per impostazione predefinita, tutti i dati ricevuti nella risposta vengono passati senza modifiche all'app che ha originato la richiesta.

In che modo i dati della richiesta vengono passati al server di backend?

La seguente immagine mostra una definizione di proxy API:

Richiesta dal client HTTP che passa attraverso l'endpoint proxy a TargetEndpoint nel backend per raggiungere il servizio HTTP. Vengono forniti esempi di endpoint proxy e di destinazione.

Per questo proxy API:

Host virtuale proxy API: default
Dominio definito dai nomi host sul gruppo di ambienti: http://www.example.com
Percorso di base proxy: /v1/weather
TargetEndpoint specificato dalla regola di route: default
URL di destinazione: http://weather.yahooapis.com

Un'app client effettua una richiesta GET al proxy API utilizzando il seguente comando curl:

curl -X GET http://www.example.com/v1/weather/forecastrss?w=12797282

Tieni presente che questa richiesta contiene la risorsa forecastrss e un parametro di query, w. Apigee analizza la richiesta come mostrato di seguito e assegna parti della richiesta alle variabili di flusso:

{request.verb} {proxy.basepath}/{proxy.pathsuffix}?{request.querystring}

Le variabili di flusso sono impostate con i seguenti valori:

request.verb: GET
proxy.basepath: /v1/weather
proxy.pathsuffix: forecastrss
request.querystring: w=12797282

TargetEndpoint effettua quindi una richiesta al servizio di backend utilizzando le informazioni della richiesta:

{request.verb} {target.basepath}/{proxy.pathsuffix}?{request.querystring}

Osserva come i parametri di query e delle risorse specificati nella richiesta vengono inclusi automaticamente nella richiesta al server di backend. Dalla definizione di TargetEndpoint, la richiesta avrà quindi il seguente formato:

curl -X GET http://weather.yahooapis.com/forecastrss?w=12797282

Come per i parametri di query, qualsiasi intestazione o parametro modulo che includi nella richiesta al proxy API viene trasmesso al server di backend. Ad esempio, effettui la richiesta seguente che include un'intestazione:

curl -X GET -H 'Content-type:application/xml' http://www.example.com/v1/weather/forecastrss?w=12797282

Oppure una richiesta nel modulo sottostante per includere un'intestazione e i dati del modulo:

curl -X POST -H "Content-type:application/json" -d \
  '{"email" : "janetutorialxml@example.com",
    "firstName" : "Jane",
    "lastName" : "Tutorial",
    "userName" : "jtutorialxml"
  }' \
  http://www.example.com/v1/register/user

In entrambi gli esempi, le intestazioni e i dati del modulo vengono passati senza modifiche al servizio di backend. Le intestazioni sono rappresentate da variabili di flusso come request.headers.count e request.headers.names. I dati del modulo sono rappresentati da variabili di flusso come request.formparam.count e request.formparam.names.

Come vengono restituiti i dati delle risposte?

Per impostazione predefinita, tutti i dati ricevuti da Apigee dal servizio di backend nella risposta vengono passati invariati all'app che ha originato la richiesta. Come descritto in precedenza per la richiesta, i dati restituiti nella risposta sono accessibili tramite variabili di flusso su Apigee. Per maggiori informazioni, consulta la documentazione di riferimento sulle variabili di flusso.

Dati di richieste e risposte di accesso in un proxy API

In molti casi è necessario modificare i dati delle richieste prima di inviarli al server di backend. Ad esempio:

Per rimuovere le informazioni di sicurezza utilizzate da Apigee per convalidare le richieste. Queste informazioni non sono richieste dal servizio di backend.
Per aggiungere i dati inviati al servizio di backend, ad esempio per monitorare gli utenti o per raccogliere dati e analisi.
Per elaborare la richiesta in modo condizionale in base ai dati della richiesta. Ad esempio, un proxy API può avere più TargetEndpoint. TargetEndpoint utilizzato dalla richiesta è determinato dai dati della richiesta. Puoi quindi rimuovere questi dati dalla richiesta prima di inviarli al servizio di backend.

Lo stesso vale per i dati nella risposta. Durante l'elaborazione della risposta, il proxy API potrebbe voler modificare i dati prima di restituirli all'app richiedente.

Messaggi di richiesta di accesso

Puoi utilizzare i criteri per accedere a parti di un messaggio di richiesta e modificarle. Queste parti includono:

Intestazioni
I parametri di ricerca
Parametri modulo
Indirizzo IP di origine
Corpo del messaggio HTTP

In un flusso normale, una volta elaborata la richiesta, il proxy invia la richiesta trasformata alla destinazione.

I criteri possono esaminare le variabili della richiesta, quindi trasformarla o rifiutarla in base ai contenuti di queste variabili. I criteri trasformano la richiesta impostando le variabili appropriate, ad esempio variabili di esempio corrispondenti alle intestazioni della richiesta.

Suggerimento: puoi utilizzare le variabili per ricostruire l'URL della richiesta in entrata. Ad esempio, il seguente codice in un criterio JavaScript assembla l'URL della richiesta dalle sue parti:

var req_verb = context.getVariable('request.verb');
var req_scheme = context.getVariable('client.scheme');
var req_host = context.getVariable('request.header.host');
var req_request_uri = context.getVariable('request.uri');
var req_url = req_scheme + "://" + req_host + req_request_uri;

Il risultato della concatenazione potrebbe essere il seguente:

https://www.example.com/sample

Accedere ai messaggi di risposta

Utilizzando le variabili che si applicano al messaggio di risposta, i criteri possono accedere ai componenti del messaggio, tra cui l'intestazione, i parametri di ricerca e i parametri del modulo, l'indirizzo IP di origine, il corpo del messaggio HTTP e così via.

Il proxy riceve un messaggio di risposta e applica una serie di criteri, in base alle condizioni valutate in base alla risposta, che possono modificare o trasformare la risposta.

I criteri possono esaminare le variabili di risposta, quindi trasformare o rifiutare la richiesta in base ai contenuti di queste variabili. I criteri trasformano la risposta impostando le variabili appropriate, ad esempio variabili di esempio corrispondenti alle intestazioni della risposta.

Criteri comuni per accedere alle variabili di flusso

Apigee definisce diversi criteri che puoi utilizzare per elaborare i dati della richiesta e della risposta. Questi criteri includono:

CriterioAssignMessage: crea o modifica i messaggi di richiesta o risposta HTTP durante un flusso di proxy API. Inoltre, crea e compila nuove variabili di flusso.
Criterio ExtractVariables: estrae i contenuti dai messaggi, inclusi intestazioni, percorsi URI, payload e parametri di ricerca, da utilizzare in un'istruzione di condizione. Il criterio applica quindi un pattern di testo ai contenuti dei messaggi e, dopo aver trovato una corrispondenza, imposta una variabile designata.
Criterio JSONtoXML e Criterio XMLtoJSON: converti i messaggi da JavaScript Object Notation (JSON) nel formato XML (Extensible Markup Language) o viceversa.
Criterio JavaCallout, Criterio JavaScript, Criterio PythonScript, Norme RegularExpressionProtection: questi criteri consentono di scrivere uno script per accedere alle variabili di flusso contenenti i dati relativi a richieste e risposte.