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 trasmettere alcune o tutte le seguenti informazioni, a seconda della configurazione del proxy API:

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

Per impostazione predefinita, tutti i dati di una richiesta vengono trasferiti invariati da ProxyEndpoint a TargetEndpoint. Pertanto, quando TargetEndpoint invia la richiesta al server di backend, tutte le informazioni nella richiesta originale vengono trasmesse 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 invariati all'app che ha generato la richiesta.

Come vengono trasmessi i dati della richiesta al server di backend?

L'immagine seguente mostra una definizione di proxy API:

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

Per questo proxy API:

  • Host virtuale del proxy API: default
  • Dominio definito dai nomi host nel gruppo di ambienti: http://www.example.com
  • Percorso base del proxy: /v1/weather
  • TargetEndpoint specificato dalla regola di routing: default
  • Target URL: 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}

Nota come i parametri di risorsa e query specificati nella richiesta vengano inclusi automaticamente nella richiesta al server di backend. Dalla definizione di TargetEndpoint, la richiesta assume la forma:

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

Come i parametri di query, tutte le intestazioni o i parametri del modulo inclusi nella richiesta al proxy API vengono passati al server di backend. Ad esempio, invii la seguente richiesta 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 seguente 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 invariati 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 di risposta?

Per impostazione predefinita, tutti i dati ricevuti da Apigee dal servizio di backend nella risposta vengono passati senza modifiche all'app 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 la sezione Riferimento alle variabili di flusso.

Accedere ai dati di richiesta e risposta in un proxy API

Molte volte è necessario modificare i dati della richiesta 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 dati inviati al servizio di backend, ad esempio per monitorare gli utenti o raccogliere dati di analisi.
  • Per elaborare la richiesta in modo condizionale in base ai dati della richiesta. Ad esempio, un proxy API può avere più TargetEndpoint. L'endpoint di destinazione utilizzato dalla richiesta è determinato dai dati della richiesta. Quindi, rimuovi questi dati dalla richiesta prima di inviarla 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 le policy per accedere e modificare parti di un messaggio di richiesta. Queste parti includono:

  • Intestazioni
  • Parametri di query
  • Parametri della postura
  • 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.

Le norme possono esaminare le variabili della richiesta, quindi trasformare o rifiutare la richiesta in base al contenuto di queste variabili. I criteri trasformano la richiesta impostando le variabili appropriate, ad esempio le variabili corrispondenti alle intestazioni della richiesta.

Accedere ai messaggi di risposta

Utilizzando le variabili che si applicano al messaggio di risposta, i criteri possono accedere ai componenti del messaggio inclusi 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, quindi applica una serie di policy in base alle condizioni valutate nella risposta, che possono modificare o trasformare la risposta.

Le norme possono esaminare le variabili di risposta, quindi trasformare o rifiutare la richiesta in base al contenuto di queste variabili. I criteri trasformano la risposta impostando le variabili appropriate, ad esempio le variabili corrispondenti alle intestazioni di risposta.

Policy comuni per accedere alle variabili di flusso

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

  • Criterio AssignMessage: crea o modifica i messaggi di richiesta o risposta HTTP durante un flusso del proxy API. Crea e compila anche nuove variabili di flusso.
  • Norma ExtractVariables: estrai contenuti dai messaggi, inclusi intestazioni, percorsi URI, payload e parametri di ricercay, da utilizzare in un'istruzione condizionale. La norma applica quindi un pattern di testo ai contenuti del messaggio e, una volta trovata una corrispondenza, imposta una variabile designata.
  • Criterio JSONtoXML e criterio XMLtoJSON: Converti i messaggi dal formato JavaScript Object Notation (JSON) al formato Extensible Markup Language (XML) o viceversa.
  • Norma JavaCallout, norma JavaScript, norma PythonScript, norma RegularExpressionProtection: queste norme ti consentono di scrivere uno script per accedere alle variabili di flusso contenenti dati di richiesta e risposta.