Utilizzo delle variabili di flusso

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza la documentazione di Apigee Edge.

Le variabili di flusso sono oggetti a cui puoi accedere dall'interno dei criteri o delle utilità (ad esempio lo strumento di debug). Consentono di mantenere lo stato associato a una transazione API elaborata da Apigee.

Che cosa sono le variabili di flusso?

Le variabili di flusso esistono nel contesto di un flusso proxy API e monitorano lo stato di una transazione API nel modo in cui le variabili denominate tracciano lo stato in un programma software. Le variabili di flusso memorizzano informazioni come:

  • Indirizzo IP, intestazioni, percorso URL e payload inviati dall'app richiedente
  • Informazioni sul sistema, come la data e l'ora in cui Apigee riceve una richiesta
  • Dati derivati quando viene eseguito un criterio. Ad esempio, dopo l'esecuzione di un criterio che convalida un token OAuth, Apigee crea variabili di flusso contenenti informazioni come il nome dell'applicazione richiedente.
  • Informazioni sulla risposta dal sistema di destinazione

Alcune variabili sono integrate in Apigee e vengono compilate automaticamente ogni volta che viene ricevuta una richiesta API. Sono disponibili durante una transazione API. Puoi anche creare variabili personalizzate mediante criteri come il criterioAssignMessage o nel codice JavaScript e Java.

Come vedrai, l'ambito delle variabili è definito e la posizione in cui sono accessibili dipende in parte da quando vengono create nel flusso proxy API. In generale, quando viene creata una variabile, questa è disponibile per tutti i criteri e il codice che verranno eseguiti in un secondo momento nel flusso di transazione dell'API.

Come vengono utilizzate le variabili di flusso?

Le variabili di flusso vengono utilizzate nei criteri e nei flussi condizionali:

  • I criteri possono recuperare lo stato dalle variabili di flusso e utilizzarle per svolgere il proprio lavoro.

    Ad esempio, un criterio VerificationJWT può recuperare il token da verificare da una variabile di flusso e quindi eseguire la verifica su di esso. Come ulteriore esempio, un criterio JavaScript può recuperare le variabili di flusso e codificare i dati al loro interno.

  • I flussi condizionali possono fare riferimento a variabili di flusso per indirizzare il flusso di un'API tramite Apigee, in modo simile al modo in cui funziona un'istruzione switch nella programmazione.

    Ad esempio, un criterio per restituire un errore potrebbe essere eseguito solo quando è impostata una determinata variabile di flusso.

Vediamo alcuni esempi di come le variabili vengono utilizzate in ciascuno di questi contesti.

Variabili di flusso nei criteri

Alcuni criteri prendono le variabili di flusso come input.

Ad esempio, il seguente criterioAssignMessage prende il valore della variabile di flusso client.ip e lo inserisce in un'intestazione della richiesta denominata My-Client-IP. Se viene aggiunto al flusso di richiesta, questo criterio imposta un'intestazione che viene passata alla destinazione del backend. Se impostata nel flusso della risposta, l'intestazione viene inviata nuovamente all'app client.

<AssignMessage name="set-ip-in-header">
    <AssignTo createNew="false" transport="http" type="request">request</AssignTo>
    <Set>
        <Headers>
            <Header name="My-Client-IP">{client.ip}</Header>
        </Headers>
    </Set>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
</AssignMessage>

Per un altro esempio, quando viene eseguito un criterio per le quote, diverse variabili di flusso vengono completate con valori relativi ai criteri. Una di queste variabili è denominata ratelimit.my-quota-policy.used.count (dove my-quota-policy è il nome del criterio per le quote che ti interessa).

In seguito potresti eseguire un flusso condizionale che indica che "se il conteggio della quota attuale è inferiore al 50% della quota massima ed è tra le 09:00 e le 17:00, applica una quota diversa". Questa condizione potrebbe dipendere dal valore del conteggio della quota attuale e da una variabile di flusso denominata system.time, che è una delle variabili integrate di Apigee.

Variabili di flusso nei flussi condizionali

I flussi condizionali valutano le variabili di flusso e consentono ai proxy di comportarsi in modo dinamico. In genere le condizioni vengono utilizzate per modificare il comportamento di flussi, passaggi e regole di route.

Ecco un flusso condizionale che valuta il valore della variabile request.verb in un passaggio del flusso proxy. In questo caso, se il verbo della richiesta è POST, viene eseguito il criterio VerificationAPIKey. Questo è un pattern comune utilizzato nelle configurazioni dei proxy API.

<PreFlow name="PreFlow">
    <Request>
        <Step>
            <Condition>request.verb equals "POST"</Condition>
            <Name>VerifyApiKey</Name>
        </Step>
    </Request>
</PreFlow>

Ora potresti chiederti da dove provengono le variabili come request.verb, client.ip e system.time? Quando vengono create un'istanza e compilate con un valore? Per capire quando vengono create le variabili e quando sono disponibili, consulta Visualizzare il flusso di un proxy API.

Variabili di flusso nel codice JavaScript richiamate con il criterio JavaScript

Con i criteri JavaScript, puoi eseguire codice JavaScript dall'interno del contesto di un flusso proxy API. Il codice JavaScript eseguito da questo criterio utilizza il modello a oggetti JavaScript di Apigee, che fornisce l'accesso al codice personalizzato per gli oggetti di richiesta, risposta e contesto associati al flusso proxy API in cui viene eseguito il codice. Ad esempio, questo codice imposta un'intestazione della risposta con il valore ottenuto dalla variabile di flusso target.name.

context.setVariable("response.header.X-Apigee-Target", context.getVariable("target.name"));

Questa tecnica di utilizzo di JavaScript per leggere e impostare le variabili è simile al lavoro che puoi fare con il criterioAssignMessage (mostrato in precedenza). È solo un altro modo per svolgere lo stesso tipo di attività su Apigee. La chiave da ricordare è che JavaScript eseguito dal criterio JavaScript ha accesso a tutte le variabili di flusso esistenti e che sono in ambito nel flusso del proxy API.

Visualizzazione del flusso di un proxy API

Per comprendere l'ambito delle variabili di flusso, è importante comprendere o visualizzare il modo in cui i messaggi passano attraverso un proxy API. Un proxy API è costituito da una serie di passaggi di elaborazione dei messaggi organizzati in un flusso. In ogni passaggio di un flusso proxy, il proxy valuta le informazioni disponibili e decide come procedere. Durante il processo, il proxy potrebbe eseguire il codice del criterio o eseguire la diramazione condizionale.

La figura seguente illustra questa sequenza di flussi. Osserva come i flussi sono composti da quattro segmenti principali: richiesta ProxyEndpoint, richiesta TargetEndpoint, risposta TargetEndpoint e risposta ProxyEndpoint.

Una richiesta client HTTP passa attraverso un proxy API al servizio HTTP, quindi la risposta passa di nuovo al client tramite il proxy API.

Tieni a mente questa struttura di flusso quando iniziamo a esplorare le variabili di flusso nel resto di questo argomento.

Correlazione dell'ambito della variabile al flusso proxy

Non appena sei in grado di visualizzare il flusso dei messaggi attraverso un proxy, come descritto in precedenza, puoi iniziare a capire l'ambito della variabile. Per ambito, intendiamo il punto nel ciclo di vita del flusso proxy in cui viene creata l'istanza di una variabile per la prima volta.

Ad esempio, se al segmento di richieste ProxyEndpoint è associato un criterio, questo non potrà accedere alle variabili il cui ambito è il segmento di richieste TargetEndpoint. Il motivo è che il segmento di richiesta TargetEndpoint del flusso non è stato ancora eseguito, quindi il proxy API non ha avuto la possibilità di compilare le variabili in quell'ambito.

La seguente tabella elenca l'insieme completo di ambiti delle variabili e indica quando sono disponibili nel flusso proxy.

Ambito variabile Dove vengono compilate queste variabili
richiesta proxy Il segmento di richiesta ProxyEndpoint
richiesta di destinazione Il segmento di richiesta TargetEndpoint
risposta target Il segmento di risposta TargetEndpoint
risposta proxy Il segmento di risposta ProxyEndpoint
sempre disponibile Non appena il proxy riceve una richiesta. Queste variabili sono disponibili durante l'intero ciclo di vita del flusso proxy.

Ad esempio, esiste una variabile integrata Apigee denominata client.ip. Questa variabile ha l'ambito di richiesta proxy. Viene compilato automaticamente con l'indirizzo IP del client che ha chiamato il proxy. Viene compilato quando una richiesta raggiunge per la prima volta ProxyEndpoint e rimane disponibile per l'intero ciclo di vita del flusso proxy.

Esiste un'altra variabile integrata denominata target.url. L'ambito di questa variabile è richiesta di destinazione. Viene compilato nel segmento di richiesta TargetEndpoint con l'URL della richiesta inviato alla destinazione di backend. Se provi ad accedere a target.url nel segmento di richiesta ProxyEndpoint, riceverai un valore NULL. Se provi a impostare questa variabile prima che rientri nell'ambito, il proxy non fa nulla: non genera un errore e non imposta la variabile.

Ecco un semplice esempio che mostra come considerare l'ambito variabile. Supponi di voler copiare l'intero contenuto di un oggetto di richiesta (intestazioni, parametri, corpo) e di assegnarlo al payload di risposta da inviare all'app chiamante. Per questa attività puoi utilizzare il criterioAssignMessage. Il codice del criterio è simile al seguente:

<AssignMessage name="CopyRequestToResponse">
    <AssignTo type="response" createNew="false">response</AssignTo>
    <Copy source="request"/>
</AssignMessage>

Questo criterio copia semplicemente l'oggetto request e lo assegna all'oggetto response. Ma dove deve essere inserito questo criterio nel flusso proxy? La risposta è che deve essere posizionato sulla risposta TargetEndpoint, perché l'ambito della variabile di risposta è risposta target.

Riferimento alle variabili di flusso

Tutte le variabili integrate in Apigee seguono una convenzione di denominazione con la notazione dei punti. Questa convenzione consente di determinare più facilmente lo scopo della variabile. Ad esempio system.time.hour e request.content.

Apigee prenota vari prefissi per organizzare le variabili pertinenti in modo appropriato. Questi prefissi includono:

  • request
  • response
  • system
  • target

Per fare riferimento a una variabile in un criterio, inseriscila tra parentesi graffe. Ad esempio, il seguente criterioAssignMessage prende il valore della variabile client.ip e lo inserisce in un'intestazione della richiesta denominata Client-IP.

<AssignMessage name="set-ip-in-header">
    <AssignTo createNew="false" transport="http" type="request">request</AssignTo>
    <Set>
        <Headers>
            <Header name="Client-IP">{client.ip}</Header>
        </Headers>
    </Set>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
</AssignMessage>

Nei flussi condizionali, le parentesi graffe non sono necessarie. La condizione di esempio seguente valuta la variabile request.header.accept:

<Step>
    <Condition>request.header.accept = "application/json"</Condition>
    <Name>XMLToJSON</Name>
</Step>

Puoi anche fare riferimento alle variabili di flusso nel codice JavaScript e Java. Per ulteriori informazioni, vedi:

Tipo di dati delle variabili di flusso

Ogni proprietà di una variabile di flusso ha un tipo di dati ben definito, ad esempio Stringa, Lungo, Numero intero, Booleano o Raccolta. Puoi trovare i tipi di dati elencati nel riferimento sulle variabili di flusso. Per le variabili create da un criterio, consulta l'argomento di riferimento del criterio specifico per informazioni sui tipi di dati.

Le variabili che crei manualmente presumono il tipo specificato al momento della creazione e dipendono dai tipi di valori consentiti.

Utilizzo delle variabili di flusso nei criteri

Molti criteri creano variabili di flusso durante la normale esecuzione. Il riferimento dei criteri documenta tutte queste variabili specifiche per i criteri.

Quando utilizzi i proxy e i criteri, assicurati di consultare il riferimento ai criteri per scoprire quali variabili vengono create e per cosa vengono utilizzate. Ad esempio, il criterio per le quote crea un insieme di variabili contenenti informazioni su conteggi e limiti delle quote, data di scadenza e così via.

Alcune variabili dei criteri sono utili per il debug. Ad esempio, puoi utilizzare lo strumento di debug per vedere quali variabili sono state impostate in una determinata istanza in un flusso proxy.

Il criterio ExtractVariables consente di completare le variabili personalizzate con i dati estratti dai messaggi. Puoi estrarre parametri di query, intestazioni e altri dati. Ad esempio, puoi analizzare i messaggi di richiesta e risposta utilizzando pattern per estrarre dati specifici dai messaggi.

Nell'esempio seguente, il criterio ExtractVariables analizza un messaggio di risposta e archivia dati specifici ricavati dalla risposta. Il criterio crea due variabili personalizzate, geocoderesponse.latitude e geocoderesponse.longitude, e assegna loro valori.

<ExtractVariables name="ParseGeocodingResponse">
  <Source>response</Source>
  <VariablePrefix>geocoderesponse</VariablePrefix>
  <JSONPayload>
    <Variable name="latitude">
      <JSONPath>$.results[0].geometry.location.lat</JSONPath>
    </Variable>
    <Variable name="longitude">
      <JSONPath>$.results[0].geometry.location.lng</JSONPath>
    </Variable>
  </JSONPayload>
</ExtractVariables>

Anche in questo caso, tieni presente che molti criteri creano automaticamente variabili. Puoi accedere a queste variabili nel contesto del flusso proxy e sono documentate nel riferimento ai criteri in ogni singolo argomento dei criteri.

Utilizzo delle variabili di flusso nel codice JavaScript

Puoi accedere alle variabili e impostarle direttamente nel codice JavaScript in esecuzione nel contesto di un proxy API. Tramite il modello a oggetti JavaScript di Apigee, l'esecuzione di JavaScript su Apigee ha accesso diretto alle variabili di flusso del proxy.

Per accedere alle variabili nel codice JavaScript, chiama i metodi getter/setter su uno qualsiasi di questi oggetti:

  • context
  • proxyRequest
  • proxyResponse
  • targetRequest
  • targetResponse

Come puoi vedere, questi riferimenti agli oggetti corrispondono ai segmenti familiari del modello di flusso proxy, come spiegato in precedenza in Visualizzazione del flusso di un proxy API.

L'oggetto context corrisponde alle variabili disponibili a livello globale, come le variabili di sistema. Ad esempio, puoi chiamare getVariable() sull'oggetto context per ottenere l'anno in corso:

var year = context.getVariable('system.time.year');

Allo stesso modo, puoi chiamare setVariable() per impostare il valore di una variabile personalizzata o per qualsiasi variabile preconfigurata scrivibile. Qui creiamo una variabile personalizzata denominata organization.name.myorg a cui assegniamo un valore.

var org = context.setVariable('organization.name.myorg', value);

Poiché questa variabile viene creata con l'oggetto context, sarà disponibile per tutti i segmenti di flusso (in pratica, è come creare una variabile globale).

Puoi anche ottenere o impostare variabili di flusso proxy nel codice Java da eseguire con il criterio JavaCallout.

Informazioni importanti

Di seguito sono riportati alcuni aspetti importanti da ricordare sulle variabili di flusso:

  • Alcune variabili out-of-the-box vengono create in un'istanza e compilate automaticamente dal proxy stesso. Questi aspetti sono illustrati nel riferimento delle variabili di flusso.
  • Puoi creare variabili personalizzate che puoi utilizzare nel flusso del proxy. È possibile creare variabili utilizzando criteri come il criterioAssignMessage e il Criterio JavaScript.
  • Le variabili hanno un ambito. Ad esempio, alcune variabili vengono compilate automaticamente quando il primo proxy riceve una richiesta da un'app. Altre variabili vengono compilate nel segmento del flusso di risposta del proxy. Queste variabili di risposta rimangono non definite fino all'esecuzione del segmento di risposta.
  • Quando i criteri vengono eseguiti, possono creare e compilare variabili specifiche per i criteri. La documentazione di ciascun criterio elenca tutte queste variabili pertinenti specifiche per i criteri.
  • I flussi condizionali in genere valutano una o più variabili. Per creare flussi condizionali, devi comprendere le variabili.
  • Molti criteri utilizzano variabili come input o output. Una variabile creata da un criterio potrebbe essere utilizzata in seguito da un altro.

Argomenti correlati

  • Tutte le variabili che vengono compilate automaticamente in un proxy API sono elencate nel riferimento delle variabili di flusso. Il riferimento indica anche il tipo e l'ambito di ogni variabile.
  • Se vuoi sapere quali variabili vengono compilate da un criterio specifico, fai riferimento all'argomento di riferimento per il criterio. Ad esempio, consulta Variabili di flusso nel riferimento dei criteri per le quote.