Modello oggetto JavaScript

Questa pagina si applica a Apigee e Apigee ibrido.

Visualizza la documentazione di Apigee Edge.

Questo argomento illustra il modello a oggetti JavaScript di Apigee. È importante comprendere questo modello se intendi utilizzare il criterio JavaScript per aggiungere JavaScript personalizzato a un proxy API.

Informazioni sul modello a oggetti JavaScript

Il modello a oggetti JavaScript definisce oggetti con proprietà associate disponibili per il codice JavaScript in esecuzione all'interno di un flusso proxy Apigee. Utilizza il criterio JavaScript per collegare questo codice personalizzato a un flusso proxy API.

Gli oggetti definiti da questo modello hanno un ambito all'interno del flusso proxy API, il che significa che alcuni oggetti e proprietà sono disponibili solo in punti specifici del flusso. Quando viene eseguito JavaScript, viene creato un ambito. In questo ambito, vengono creati questi riferimenti agli oggetti:

• context: un oggetto che fornisce accesso al contesto del messaggio
• request:una forma abbreviata che consente di accedere all'oggetto della richiesta.
• response: una forma abbreviata che consente di accedere all'oggetto della risposta.
• crypto: fornisce varie funzioni hash
• print: una funzione che emette un output
• properties: consente l'accesso in lettura alle proprietà di configurazione nel criterio.

L'oggetto di contesto

L'oggetto context ha un ambito globale. È disponibile ovunque all'interno del flusso del proxy API. Ha quattro oggetti secondari: proxyRequest, proxyResponse, targetRequest, targetResponse. Questi oggetti figlio hanno come ambito la richiesta e la risposta ambientali, ovvero la richiesta e la risposta proxy o la richiesta e la risposta di destinazione. Ad esempio, se il criterio JavaScript viene eseguito nella parte dell'endpoint proxy del flusso, gli oggetti context.proxyRequest e context.proxyResponse rientrano nell'ambito. Se JavaScript viene eseguito in un flusso di destinazione, gli oggetti context.targetRequest e context.targetResponse rientrano nell'ambito.

L'oggetto context include anche proprietà e metodi, descritti in dettaglio in questo argomento. Ad esempio, il seguente esempio di codice JavaScript utilizza la proprietà context.flow e chiama i metodi get/setVariable() su context.

if (context.flow=="PROXY_REQ_FLOW") {
     var username = context.getVariable("request.formparam.user");
     context.setVariable("USER.name", username);
}

Questi metodi interagiscono direttamente con le variabili di flusso. Il valore della proprietà context.flow è l'ambito del flusso attuale. Nel flusso di richieste proxy è impostato sulla costante PROXY_REQ_FLOW. Se nel flusso di risposta di destinazione è impostato su TARGET_RESP_FLOW. Questa costante è utile per eseguire codice specifico per ambito. Il getter ti consente di ottenere variabili di flusso e il setter ti consente di impostare variabili di flusso. Queste variabili sono generalmente disponibili nel flusso proxy e possono essere utilizzate da altri criteri.

Consulta la pagina Riferimento agli oggetti di contesto per ulteriori dettagli ed esempi.

L'oggetto crypto

L'oggetto crittografico aggiunge il supporto crittografico di base e ad alte prestazioni al modello a oggetti JavaScript. Consulta la documentazione di riferimento degli oggetti crypto per ulteriori dettagli ed esempi.

Gli oggetti di richiesta e risposta

Gli oggetti request e response sono riferimenti abbreviati alla richiesta e alla risposta Ambient, che possono essere richieste e risposte proxy o richieste e risposte di destinazione. Gli oggetti a cui fanno riferimento queste variabili dipendono dal contesto in cui viene eseguito il criterio JavaScript. Se JavaScript viene eseguito nel flusso di un endpoint proxy, le variabili di richiesta e risposta faranno riferimento a context.proxyRequest e context.proxyResponse. Se JavaScript viene eseguito in un flusso target, le variabili fanno riferimento a context.targetRequest e context.targetResponse.

La funzione stampa()

Il modello a oggetti JavaScript include una funzione stampa() che puoi utilizzare per inviare le informazioni di debug allo strumento di debug Apigee. Consulta Debug con le istruzioni Print() di JavaScript.

L'oggetto delle proprietà

Quando utilizzi un elemento Properties nella configurazione dei criteri, il codice JavaScript può accedere ai valori di queste proprietà utilizzando la variabile properties.

Ad esempio, se la configurazione JavaScript contiene:

<Javascript name='JS-1' >
  <Properties>
    <Property name="number">8675309</Property>
    <Property name="firstname">Jenny</Property>
  </Properties>
  <ResourceURL>jsc://my-code.js</ResourceURL>
</Javascript>

In my-code.js potrai:

  print(properties.firstname);  // prints Jenny
  print(properties.number);  // 8675309

Più praticamente, la configurazione può consentire al codice di comportarsi in modo diverso quando viene eseguito in ambienti diversi, in momenti diversi o per qualsiasi motivo.

Ad esempio, quanto segue specifica il "nome variabile" e lo stile dell'output in cui il codice JavaScript deve emettere informazioni:

<Javascript name='JS-2' >
  <Properties>
    <Property name="output">my_output_variable</Property>
    <Property name="prettyPrint">true</Property>
  </Properties>
  <ResourceURL>jsc://emit-results.js</ResourceURL>
</Javascript>

Nel caso di emit-results.js, il codice potrebbe fare questo:

var result = { prop1: "something", prop2 : "something else" } ;
if (properties.prettyPrint == "true") {
  context.setVariable(properties.output, JSON.stringify(result, null, 2));
}
else {
  context.setVariable(properties.output, JSON.stringify(result));
}

Riferimento agli oggetti crypto

L'oggetto crittografico consente di eseguire le funzioni di hashing crittografico di base in JavaScript.

Nota: le funzioni crittografiche supportano solo l'hashing; non è disponibile alcun supporto per la crittografia bidirezionale.

L'oggetto crypto ha un ambito globale. È disponibile ovunque all'interno del flusso del proxy API. La crittografia consente di lavorare con i seguenti oggetti hash:

• SHA-1
• SHA256
• SHA512
• MD5

Suggerimento: Apigee consiglia di utilizzare l'oggetto crypto per eseguire funzioni crittografiche di base nei programmi JavaScript in esecuzione su Apigee.

Utilizzo degli oggetti SHA-1

Puoi creare oggetti SHA-1, aggiornarli e convertirli in valori esadecimali e base64.

Crea un nuovo oggetto SHA-1

var _sha1 = crypto.getSHA1();

Aggiornare un oggetto SHA-1

Sintassi

_sha1.update(value);

Parametri

• value - (Stringa) qualsiasi valore stringa.

Esempio

Aggiorna un oggetto SHA-1:

_sha1.update("salt_value");

_sha1.update("some text");

Restituisci l'oggetto SHA-1 come stringa esadecimale

var _hashed_token = _sha1.digest();

Restituisci l'oggetto SHA-1 come stringa base64

var _hashed_token = _sha1.digest64();

Utilizzo degli oggetti SHA-256

Puoi creare oggetti SHA-256, aggiornarli e convertirli in valori esadecimali e base64.

Crea un nuovo oggetto SHA-256

var _sha256 = crypto.getSHA256();

Aggiornare un oggetto SHA-256

Sintassi

_sha256.update(value);

Parametri

• value - (Stringa) qualsiasi valore stringa.

Esempio

Aggiorna un oggetto SHA-256:

_sha256.update("salt_value");

_sha256.update("some text");

Restituisci l'oggetto SHA-256 come stringa esadecimale

var _hashed_token = _sha256.digest();

Restituisci l'oggetto SHA-256 come stringa base64

var _hashed_token = _sha256.digest64();

Utilizzo degli oggetti SHA-512

Puoi creare oggetti SHA-512, aggiornarli e convertirli in valori esadecimali e base64.

Crea un nuovo oggetto SHA-512

var _sha512 = crypto.getSHA512();

Aggiornare un oggetto SHA-512

Sintassi

_sha512.update(value);

Parametri

• value - (Stringa) qualsiasi valore stringa.

Esempio

Aggiorna un oggetto SHA-512:

_sha512.update("salt_value");

_sha512.update("some text");

Restituisci l'oggetto SHA-512 come stringa esadecimale

var _hashed_token = _sha512.digest();

Restituisci l'oggetto SHA-512 come stringa base64

var _hashed_token = _sha512.digest64();

Utilizzo degli oggetti MD5

È possibile creare oggetti MD5, aggiornarli e convertirli in valori esadecimali e base64.

Crea un nuovo oggetto MD5

var _md5 = crypto.getMD5();

Aggiornare un oggetto MD5

Sintassi

_md5.update(value);

Parametri

• value - (Stringa) qualsiasi valore stringa.

Esempio

Aggiorna un oggetto MD5:

_md5.update("salt_value");

_md5.update("some text");

Restituisci l'oggetto MD5 come stringa esadecimale

var _hashed_token = _md5.digest();

Restituisci l'oggetto MD5 come stringa base64

var _hashed_token = _md5.digest64();

Supporto di data/ora per la crittografia

L'oggetto crypto supporta pattern di formattazione di data/ora.

crypto.dateFormat()

Restituisce una data in formato stringa.

Sintassi

crypto.dateFormat(format, [timezone], [time])

Parametri

• format - (Stringa) L'implementazione di base per questo parametro è java.text.SimpleDateFormat. Ad esempio: "AAAA-MM-GG HH:mm:ss.SSS".
• timezone: (stringa, facoltativa). L'implementazione di base per questo parametro è java.util.TimeZone. Questo parametro è uguale al valore predefinito: UTC
• time - (Numero, facoltativo): un valore del timestamp Unix da formattare. Valore predefinito: ora attuale

Esempi

Nota: la documentazione java.text.SimpleDateFormat fornisce un elenco completo di tutti i caratteri e le combinazioni di caratteri per la formattazione di data/ora, oltre a esempi dettagliati.

Visualizza l'ora attuale, ridotta in millisecondi:

var _now = crypto.dateFormat('YYYY-MM-DD HH:mm:ss.SSS');

Vedere l'ora attuale per il fuso orario del Pacifico:

var _pst = crypto.dateFormat('YYYY-MM-DD HH:mm:ss.SSS','PST');

Ottieni il valore dei dieci secondi a partire da ora:

var _timeNow = Number(context.getVariable('system.timestamp'));
var tenSeconds = crypto.dateFormat('YYYY-MM-DD HH:mm:ss.SSS','PST', _timeNow + 10 * 1000);

Altri esempi. Vedi anche la documentazione java.text.SimpleDateFormat.

var _pst = crypto.dateFormat('M');

var _pst = crypto.dateFormat('EEE, d MMM yyyy HH:mm:ss Z');

var _pst = crypto.dateFormat("yyyy-MM-dd'T'HH:mm:ss.SSSZ");

Utilizza getHash() per ottenere gli oggetti hash supportati

Esempi

var _hash1 = crypto.getHash('MD5');

var _hash2 = crypto.getHash('SHA-1');

var _hash3 = crypto.getHash('SHA-256');

var _hash4 = crypto.getHash('SHA-512');

Anteprima con criptovalute

try {
    // get values to use with hash functions
    var salt = context.getVariable("salt") || 'SomeHardCodedSalt';
    var host = context.getVariable("request.header.Host");
    var unhashedToken = "";

    var _timeNow = Number(context.getVariable('system.timestamp'));
    var now = crypto.dateFormat('YYYY-MM-DD HH:mm:ss.SSS','PST', _timeNow);
    unhashed_token = "|" + now + "|" + host

    // generate a hash with the unhashedToken:
    var sha512 = crypto.getSHA512();
    sha512.update(salt);
    sha512.update(unhashedToken);

    // convert to base64
    var base64Token = sha512.digest64();

    // set headers
    context.setVariable("request.header.now", now);
    context.setVariable("request.header.token", base64Token);

} catch(e) {
    throw 'Error in Javascript';
}

riferimento all'oggetto di contesto

• riepilogo degli oggetti di contesto
• metodi dell'oggetto di contesto
• proprietà dell'oggetto di contesto
• oggetti di contesto secondari

Viene creato un oggetto context per ogni transazione di richiesta/risposta eseguita da un proxy API. L'oggetto context espone metodi per ottenere, impostare e rimuovere le variabili relative a ogni transazione.

Le variabili definiscono le proprietà specifiche di una transazione. Ora del giorno, impostazioni internazionali del client richiedente, user agent del client richiedente e URL del servizio di destinazione sono tutti esempi di variabili disponibili in context. Di conseguenza, context è utile per creare una logica che si basa su queste proprietà per eseguire un comportamento personalizzato.

Consulta le sezioni Riferimento alle variabili di flusso e Criterio Takeout.

riepilogo dell'oggetto di contesto

Questa tabella descrive brevemente l'oggetto di contesto e i relativi oggetti secondari ed elenca le proprietà associate a ciascuno.

Nome	Descrizione	Proprietà
context	Un wrapper per il contesto della pipeline di elaborazione dei messaggi e i flussi di richiesta e risposta eseguiti da ProxyEndpoint e TargetEndpoint.	flusso, sessione
context.proxyRequest	Un oggetto che rappresenta il messaggio di richiesta in entrata al ProxyEndpoint (dall'app richiedente al proxy API)	intestazioni, parametri di ricerca, metodo, corpo, url
context.targetRequest	Un oggetto che rappresenta il messaggio di richiesta in uscita dal TargetEndpoint (dal proxy API al servizio di backend).	intestazioni, parametri di ricerca, metodo, corpo, url
context.targetResponse	Un oggetto che rappresenta il messaggio di risposta di destinazione in entrata (dal servizio di backend al proxy API)	intestazioni, contenuti, stato
context.proxyResponse	Un oggetto che rappresenta il messaggio di risposta del proxy in uscita (dal proxy API all'app richiedente)	intestazioni, contenuti, stato
context.flow	Il nome del flusso attuale.	Vedi context.flow.
context.session	Una mappa di coppie nome/valore che puoi utilizzare per trasferire oggetti tra due diversi passaggi eseguiti nello stesso contesto. Ad esempio: context.session['key'] = 123.	Per ulteriori informazioni su quando e quando non utilizzare questo oggetto, vedi Qual è la differenza tra context.session['hello'] = {} e context.setVariable("hello", {}).

metodi dell'oggetto di contesto

context.getVariable()

Recupera il valore di una variabile predefinita o personalizzata.

Sintassi

context.getVariable("variable-name");

Esempio

Per ottenere il valore per l'anno in corso:

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

context.setVariable()

Imposta il valore per una variabile personalizzata o per qualsiasi variabile predefinita scrivibile.

Sintassi

context.setVariable("variable-name", value);

Esempio

Uno scenario comune per l'impostazione di una variabile è quando un proxy API deve scrivere dinamicamente l'URL di destinazione. Il codice JavaScript seguente ottiene il valore di una variabile denominata USER.name, lo aggiunge come parametro di query all'URL http://mocktarget.apigee.net?user=, quindi imposta target.url predefinito a questo valore.

context.setVariable("target.url", "http://mocktarget.apigee.net/user?user="+context.getVariable("USER.name"));

Suggerimento: qualsiasi variabile predefinita accessibile in scrittura e qualsiasi variabile personalizzata può essere impostata dinamicamente da JavaScript. Per un elenco completo delle variabili predefinite, consulta Riferimento per le variabili di flusso.

context.removeVariable()

Rimuove una variabile dal contesto.

Sintassi

context.removeVariable('variable-name');

proprietà degli oggetti di contesto

context.flow

La proprietà flow è una stringa che identifica il flusso proxy API corrente. Questa proprietà viene utilizzata per indicare il flusso a cui è collegato il codice JavaScript. I valori supportati sono:

• PROXY_REQ_FLOW
• PROXY_RESP_FLOW
• TARGET_REQ_FLOW
• TARGET_RESP_FLOW

Ciascun nome di flusso comprende PreFlow, PostFlow e tutti i flussi condizionali definiti negli endpoint proxy o negli endpoint di destinazione.

Questa proprietà facoltativa è utile quando il codice JavaScript comune viene eseguito in più di un flusso, ma potrebbe variare il suo comportamento a seconda del flusso in cui viene eseguito. Utilizza la proprietà Flow per i moduli JavaScript destinati a essere riutilizzati in più proxy API, in cui il codice deve verificare il flusso attuale prima di eseguire la logica.

Esempio

Imposta un'intestazione HTTP solo sul flusso targetRequest:

if (context.flow=="TARGET_REQ_FLOW") {
     context.targetRequest.headers['TARGET-HEADER-X']='foo';
}

Imposta i contenuti solo sul flusso proxyResponse:

if (context.flow=="PROXY_RESP_FLOW") {
     context.proxyResponse.content='bar';
}

context.session

Una mappa di coppie nome/valore che può essere utilizzata per passare oggetti tra due criteri in esecuzione nello stesso contesto di messaggio.

Nota: è importante comprendere la differenza tra l'uso di context.session per ottenere/impostare le variabili e l'uso di context.getVariable() e context.setVariable(). Consulta questa discussione della community Apigee per ulteriori dettagli.

Esempio

Imposta un valore nella sessione:

context.session['key']  = 123;

Ottieni il valore dalla sessione:

var value = context.session['key']; // 123

Esempio: per un esempio funzionante che utilizza l'oggetto context.session, vedi il proxy API di esempio Callout asincrono.

oggetti di contesto secondari

Come mostrato di seguito, un flusso proxy API completo comprende quattro fasi distinte, ciascuna delle quali ha un oggetto di messaggio associato che è figlio dell'oggetto di contesto:

• context.proxyRequest: il messaggio di richiesta in entrata ricevuto dal client richiedente.
• context.targetRequest: il messaggio di richiesta in uscita inviato al servizio di backend.
• context.proxyResponse: il messaggio di risposta in uscita restituito al client richiedente.
• context.targetResponse: il messaggio di richiesta in entrata ricevuto dal servizio di backend.

Le seguenti sezioni descrivono i metodi e le proprietà di questi oggetti:

• context.*Richiedi oggetti secondari
• context.*Rispondi agli oggetti secondari

contesto.*Richiedi oggetti secondari

Per ogni transazione HTTP eseguita in un proxy API, vengono creati due oggetti di messaggio di richiesta: uno inbound (la richiesta dal client) e uno outbound (la richiesta generata dal proxy API e inviata al target del backend).

L'oggetto context include oggetti secondari che rappresentano i seguenti messaggi di richiesta: context.proxyRequest e context.targetRequest. Questi oggetti ti consentono di accedere alle proprietà all'interno del flusso di richiesta nell'ambito dell'esecuzione del codice JavaScript.

Nota: puoi anche utilizzare l'oggetto shorthand request per accedere a queste proprietà in un flusso di richiesta. L'oggetto request si riferisce a context.proxyRequest o context.targetRequest, a seconda di dove nel flusso viene eseguito il codice JavaScript.

contesto.*Richiedi proprietà degli oggetti secondari

Nome proprietà	Descrizione
url	La proprietà url è una proprietà di lettura/scrittura che combina parametri di schema, host, porta, percorso e query per la richiesta targetRequest. L'URL completo della richiesta è composto dalle seguenti proprietà: protocollo: il protocollo dell'URL, ad esempio HTTP, HTTPS. port: la porta (ad esempio, :80, :443) host: l'host dell'URL, ad esempio www.example.com path: il percorso dell'URI, ad esempio /v1/mocktarget Quando si ottiene url, viene restituito un URL nel seguente formato: protocol://host:port/path?queryParams
	Esempi: context.targetRequest.url = 'http://www.example.com/path?q1=1' context.targetRequest.protocol ='https';
headers	Intestazioni delle richieste HTTP come mappatura di String => List
	Esempi: Per questa richiesta HTTP: POST /v1/blogs HTTP/1.1 Host: api.example.com Content-Type: application/json Authorization: Bearer ylSkZIjbdWybfs4fUQe9BqP0LH5Z Il seguente codice JavaScript: context.proxyRequest.headers['Content-Type']; context.proxyRequest.headers['Authorization']; restituirà i seguenti valori application/json Bearer ylSkZIjbdWybfs4fUQe9BqP0LH5Z
queryParams	I parametri di ricerca del messaggio di richiesta come mappatura di String => List.
	Esempi: "?city=PaloAlto&city=NewYork" è accessibile come: context.proxyRequest.queryParams['city']; // == 'PaloAlto' context.proxyRequest.queryParams['city'][0] // == 'PaloAlto' context.proxyRequest.queryParams['city'][1]; // == 'NewYork' context.proxyRequest.queryParams['city'].length(); // == 2
method	Il verbo HTTP (GET, POST, PUT, DELETE. PATCH e così via) associati alla richiesta
	Esempi: Per questa richiesta: POST /v1/blogs HTTP/1.1 Host: api.example.com Content-Type: application/json Authorization: Bearer ylSkZIjbdWybfs4fUQe9BqP0LH5Z Il seguente codice JavaScript: context.proxyRequest.method; restituirà il seguente valore POST
body	Il corpo del messaggio (payload) della richiesta HTTP. Il corpo della richiesta include i seguenti membri: context.targetRequest.body.asXML; context.targetRequest.body.asJSON; context.targetRequest.body.asForm;
	Esempi: Per un corpo XML: <customer number='1'> <name>Fred<name/> <customer/> Per accedere agli elementi dell'oggetto XML, procedi nel seguente modo: var name = context.targetRequest.body.asXML.name; Per accedere agli attributi XML, utilizza la notazione @. var number = context.targetRequest.body.asXML.@number; Per il corpo di una richiesta JSON: { "a": 1 , "b" : "2" } var a = context.proxyRequest.body.asJSON.a; // == 1 var b = context.proxyRequest.body.asJSON.b; // == 2 Per leggere i parametri del modulo: "vehicle=Car&vehicle=Truck" v0 = context.proxyRequest.body.asForm['vehicle'][0]; v1 = context.proxyRequest.body.asForm['vehicle'][1];

contesto.*Risposta agli oggetti secondari

Per ogni transazione HTTP eseguita in un proxy API, vengono creati due oggetti di messaggi di risposta: uno inbound (la risposta del servizio di backend) e uno outbound (la risposta restituita al client).

L'oggetto di contesto ha oggetti secondari che rappresentano i seguenti messaggi di risposta: context.proxyResponse e context.targetResponse. Questi oggetti ti consentono di accedere alle proprietà all'interno del flusso di risposta nell'ambito dell'esecuzione del codice JavaScript.

Nota: puoi anche utilizzare l'oggetto abbreviazione response per accedere a queste proprietà da un flusso di risposta. L'oggetto response si riferisce a context.proxyResponse o context.targetResponse, a seconda di dove nel flusso viene eseguito il codice JavaScript.

contesto.*Proprietà dell'oggetto Response

Nome proprietà	Descrizione
headers	Le intestazioni HTTP del messaggio di risposta come una mappatura di String => List.
	Esempio: var cookie = context.targetResponse.headers['Set-Cookie'];
status	Il codice di stato con messaggio di stato come proprietà. Sia il codice di stato sia il messaggio di stato sono disponibili come proprietà.
	Esempio: var status = context.targetResponse.status.code; // 200 var msg = context.targetResponse.status.message; // "OK"
content	Il corpo HTTP (contenuto del payload) del messaggio di risposta. I contenuti della risposta includono i seguenti membri: context.targetResponse.content.asXML; context.targetResponse.content.asJSON;

Utilizzo della notazione .asXML

Esiste un modo pratico per analizzare un documento XML utilizzando la notazione .asXML. Questa sezione descrive come utilizzare questa notazione e in cosa differisce da request.content e context.proxyRequest.content.

Ad esempio:

request.content.asXML

o

context.proxyRequest.content.asXML

Entrambi i moduli *.content e *.content.asXML possono essere utilizzati in un contesto di stringa e JavaScript li costringerà a diventare stringhe. Nel primo caso (*.content), la stringa include tutte le dichiarazioni e i commenti XML. Nel secondo caso (*.content.asXML), il valore stringa del risultato viene eliminato da dichiarazioni e commenti.

Esempio

msg.content:

<?xml version="1.0" encoding="UTF-8"?>
<yahoo:error xmlns:yahoo="http://yahooapis.com/v1/base.rng" xml:lang="en-US">
   <yahoo:description>Please provide valid credentials. OAuth oauth_problem="unable_to_determine_oauth_type", realm="yahooapis.com"
   </yahoo:description>
</yahoo:error>
<!-- mg023.mail.gq1.yahoo.com uncompressed/chunked Sat Dec 14 01:23:35 UTC 2013 -->

msg.content.asXML:

<?xml version="1.0" encoding="UTF-8"?>
<yahoo:error xmlns:yahoo="http://yahooapis.com/v1/base.rng" xml:lang="en-US">
   <yahoo:description>Please provide valid credentials. OAuth oauth_problem="unable_to_determine_oauth_type", realm="yahooapis.com"
   </yahoo:description>
</yahoo:error>

Inoltre, puoi utilizzare il modulo .asXML per attraversare la gerarchia XML, specificando i nomi degli elementi e gli attributi. Non è possibile attraversare la gerarchia utilizzando l'altra sintassi.

Eseguire il debug con le istruzioni JavaScript Print()

Se utilizzi il criterio JavaScript per eseguire il codice JavaScript personalizzato, tieni presente che puoi utilizzare la funzione Print() per inviare le informazioni di debug allo strumento di debug. Questa funzione è disponibile direttamente tramite il modello a oggetti JavaScript. Ad esempio:

if (context.flow=="PROXY_REQ_FLOW") {
     print("In proxy request flow");
     var username = context.getVariable("request.queryparam.user");
     print("Got query param: " + username);
     context.setVariable("USER.name", username);
     print("Set query param: " + context.getVariable("USER.name"));
}


if (context.flow=="TARGET_REQ_FLOW") {
     print("In target request flow");
     var username = context.getVariable("USER.name");
     var url = "http://mocktarget.apigee.net/user?"
     context.setVariable("target.url", url + "user=" + username);
     print("Callout to URL: ", context.getVariable("target.url"));
}

Per visualizzare l'output, seleziona Output di tutte le transazioni nella parte inferiore della finestra di debug. Puoi trovare l'output anche nella proprietà Debug chiamata stepExecution-stdout.

Creazione di callout JavaScript con httpClient

Utilizza httpClient per effettuare più richieste HTTP parallele e asincrone a qualsiasi URL dall'interno del codice JavaScript personalizzato eseguito in un flusso proxy API. L'oggetto httpClient è esposto dal modello di oggetti JavaScript Apigee.

Informazioni su httpClient

L'oggetto httpClient è esposto al codice JavaScript personalizzato in esecuzione su Apigee tramite il modello a oggetti JavaScript. Per collegare JavaScript personalizzato a un proxy API, utilizza il criterio JavaScript. Quando il criterio viene eseguito, viene eseguito il codice JavaScript personalizzato.

L'oggetto httpClient è utile per lo sviluppo di servizi compositi o mashup. Ad esempio, puoi consolidare più chiamate di backend in un singolo metodo API.

Nota: un caso d'uso che sconsigliamo per il criterio JavaScript è il logging. Il criterio MessageLogging è molto più adatto per il logging a piattaforme di logging di terze parti come Splunk, Sumo e Loggly e consente di migliorare le prestazioni del proxy API eseguendo il criterio MessageLogging in PostClientFlow, che viene eseguito dopo che la risposta è stata inviata al client.

Di seguito è riportato uno schema di utilizzo di base. Crea un'istanza di un oggetto Request, assegnagli un URL (ad es. a un servizio di backend che vuoi chiamare) e chiama httpClient.send con questo oggetto di richiesta.

var myRequest = new Request();
myRequest.url = "http://www.example.com";
var exchangeObj = httpClient.send(myRequest);

httpRiferimento cliente

Il client HTTP espone due metodi: get() e send().

httpClient.get()

Un metodo pratico per semplici richieste GET HTTP, senza supporto per le intestazioni HTTP.

Utilizzo

var exchangeObj = httpClient.get(url);

Restituisce

Il metodo restituisce un oggetto exchange. Questo oggetto non ha proprietà e espone i seguenti metodi:

• isError(): (booleano) restituisce true se il httpClient non è riuscito a connettersi al server. I codici di stato HTTP 4xx e 5xx restituiscono isError() false, poiché la connessione è stata completata ed è stato restituito un codice di risposta valido. Se isError() restituisce true, una chiamata a getResponse() restituisce il codice JavaScript undefined.
• isSuccess(): (booleano) restituisce true se l'invio è stato completato correttamente.
• isComplete(): (booleano) restituisce true se la richiesta è completata.
• waitForComplete(): mette in pausa il thread fino al completamento della richiesta (se la richiesta è andata a buon fine o per errore).
  Antipattern : l'utilizzo di waitForComplete non è consigliato ed è considerato un anti-pattern. Ti consigliamo invece di utilizzare i callback. Per maggiori dettagli, consulta Antipattern: usare waitForComplete() nel codice JavaScript.
• getResponse(): (oggetto) restituisce l'oggetto risposta se httpClient.send() è stato completato correttamente. L'oggetto restituito ha metodi e proprietà identici all'oggetto context.proxyResponse. Consulta il riepilogo degli oggetti di contesto.
• getError() (stringa): se la chiamata a httpClient.send() ha generato un errore, restituisce il messaggio di errore come stringa.

Esempio

Invia un oggetto Request completamente configurato contenente le proprietà della richiesta HTTP. Utilizza un callback che non blocca l'elaborazione della risposta.

Nota : l'utilizzo dei callback per elaborare le risposte in modo asincrono è una best practice consigliata. L'utilizzo della funzione waitForComplete() non è consigliato ed è considerato un anti-pattern. Vedi anche Antipattern: usare waitForComplete() nel codice JavaScript.

// Add the required the headers for making a specific API request
var headers = {'X-SOME-HEADER' : 'some value' };
// Make a GET API request along with headers
var myRequest = new Request("http://www.example.com","GET",headers);

// Define the callback function and process the response from the GET API request
function onComplete(response,error) {
 // Check if the HTTP request was successful
    if (response) {
      context.setVariable('example.status', response.status);
     } else {
      context.setVariable('example.error', 'Woops: ' + error);
     }
}

// Specify the callback Function as an argument
httpClient.get(myRequest, onComplete);

Utilizzo del criterio JavaScript

Utilizza il criterio JavaScript per collegare il codice JavaScript personalizzato a un flusso proxy. Consulta il criterio JavaScript.

Argomenti correlati

• Criterio JavaScript
• Modello a oggetti JavaScript
• Introduzione agli anti-pattern