Variabili di richiesta e risposta

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza documentazione di Apigee Edge.

Quando effettui una richiesta a un proxy API, puoi passare una o tutte le seguenti informazioni, a seconda del modo in cui è configurato il proxy API:

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

Per impostazione predefinita, tutti i dati in una richiesta vengono passati inalterati dal ProxyEndpoint al Endpoint di destinazione. Quindi, quando TargetEndpoint effettua la richiesta al server di backend, le informazioni presenti nella richiesta originale vengono passate al servizio di backend.

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

Come vengono passati i dati delle richieste al backend server?

L'immagine seguente mostra una definizione di proxy API:

Per questo proxy API:

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

Un'app client invia una richiesta GET al proxy API utilizzando: 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

Nota: esistono molte variabili di flusso diverse create durante l'elaborazione di una richiesta e di una risposta. Per saperne di più, consulta il riferimento alle variabili di flusso.

Il TargetEndpoint invia quindi una richiesta al servizio di backend utilizzando le informazioni provenienti richiesta:

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

Tieni presente che i parametri di risorsa e query specificati nella richiesta vengono inclusi automaticamente nella richiesta al server di backend. Dalla definizione di TargetEndpoint, la richiesta ha il formato:

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

Analogamente ai parametri di query, qualsiasi intestazione o parametro del modulo che includi nella richiesta all'API vengono passati al server di backend. Ad esempio, invii la richiesta riportata di seguito che include un'intestazione:

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

In alternativa, invia una richiesta nel modulo seguente per includere un'intestazione e i dati del modulo:

curl -X POST -H "Content-type:application/json" -d \
  '{"email" : "[e-mail]",
    "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 trasmessi invariati al servizio di backend. La 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 di risposta?

Per impostazione predefinita, vengono passati tutti i dati ricevuti da Apigee dal servizio di backend nella risposta che ha generato la richiesta. Come descritto sopra per la richiesta, i dati restituiti nella risposta sono accessibili tramite le variabili di flusso su Apigee. Per ulteriori informazioni, consulta Riferimento per le variabili di flusso.

Accedere ai dati di richiesta e risposta in un proxy API

Esistono molte volte in cui potresti voler modificare i dati delle richieste prima di inviarli al backend server web. Ad esempio:

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

Lo stesso vale per i dati nella risposta. Nell'ambito dell'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 e modificare parti di un messaggio di richiesta. tra cui:

• Intestazioni
• Parametri di query
• Parametri del modulo
• Indirizzo IP di origine
• Corpo del messaggio HTTP

In un flusso normale, una volta elaborata la richiesta, il proxy invia la richiesta trasformata al target.

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

Suggerimento: puoi utilizzare le variabili per ricostruire l'URL della richiesta in arrivo. Ad esempio, il seguente codice in un regolamento JavaScript assembla l'URL della richiesta dalle relative 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 query 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, quindi applica una serie di criteri, in base alle condizioni valutate sulla risposta, che possono modificarla o trasformarla.

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

Criteri comuni per accedere alle variabili di flusso

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

• Criterio AssignMessage: 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 contenuti dai messaggi, inclusi intestazioni, percorsi URI, payload e parametri di ricerca, per utilizzarli in un'istruzione di condizione. Il criterio applica quindi un pattern di testo a dei contenuti di un messaggio e, quando viene trovata una corrispondenza, viene impostata una variabile.
• Criterio JSONtoXML e Criterio XMLtoJSON: converti i messaggi da JSON (JavaScript Object Notation) al formato XML (extensible markup language) o viceversa.
• criterio JavaCallout, criterio JavaScript, criterio PythonScript, Criterio RegularExpressionProtection: questi criteri ti consentono di scrivere uno script per accedere alle variabili di flusso contenente i dati di richiesta e risposta.