Norme JavaScript

Stai visualizzando la documentazione di Apigee Edge.
Consulta la documentazione di Apigee X. info

Cosa

Questa policy ti consente di aggiungere codice JavaScript personalizzato che viene eseguito nel contesto di un flusso proxy API. Nel codice JavaScript personalizzato, puoi utilizzare gli oggetti, i metodi e le proprietà di Apigee Edge modello oggetto JavaScript. Il modello oggetto ti consente di ottenere, impostare e rimuovere le variabili nel contesto del flusso proxy. Puoi anche utilizzare le funzioni di crittografia di base fornite con il modello oggetto.

Informazioni

Esistono molti casi d'uso per la policy JavaScript. Ad esempio, puoi ottenere e impostare le variabili di flusso , eseguire logica personalizzata ed eseguire la gestione degli errori, estrarre dati da richieste o risposte, modificare dinamicamente l'URL di destinazione del backend e molto altro ancora. Questa policy ti consente di implementare un comportamento personalizzato non coperto da altre policy Edge standard. Infatti, puoi utilizzare una policy JavaScript per ottenere molti degli stessi comportamenti implementati da altre policy, come AssignMessage ed ExtractVariable.

Un caso d'uso che non consigliamo per la policy JavaScript è la registrazione. La policy Message Logging è molto più adatta per la registrazione su piattaforme di logging di terze parti come Splunk, Sumo e Loggly e migliora il rendimento del proxy API eseguendo la policy Message Logging in PostClientFlow, che viene eseguita dopo che la risposta è stata inviata al client.

La policy JavaScript ti consente di specificare un file di origine JavaScript da eseguire o puoi includere il codice JavaScript direttamente nella configurazione della policy con l'elemento <Source>. In entrambi i casi, il codice JavaScript viene eseguito quando viene eseguito il passaggio a cui è collegata la policy. Per l'opzione del file di origine, il codice sorgente viene sempre archiviato in una posizione standard all'interno del bundle proxy: apiproxy/resources/jsc. In alternativa, puoi anche archiviare il codice sorgente in un file di risorse a livello di ambiente o organizzazione. Per le istruzioni, vedi File di risorse. Puoi anche caricare JavaScript tramite l'editor proxy dell'interfaccia utente di Apigee.

I file di origine JavaScript devono sempre avere l'estensione .js.

Per la versione di JavaScript attualmente supportata, vedi Software e versioni supportati.

Video

Guarda un breve video per scoprire come creare un'estensione di policy personalizzata utilizzando la policy JavaScript.

Esempi

curl -i -H 'Content-Type: application/x-www-form-urlencoded' -X POST -d 'user=Will' http://myorg-test.apigee.net/js-example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Javascript async="false" continueOnError="false" enabled="true" timeLimit="200" name="target-rewrite">
    <DisplayName>target-rewrite</DisplayName>
    <Properties/>
    <ResourceURL>jsc://js-example.js</ResourceURL>
</Javascript>

Riferimento elemento

Il riferimento all'elemento descrive gli elementi e gli attributi della policy JavaScript.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Javascript async="false"
        continueOnError="false" enabled="true" timeLimit="200"
        name="JavaScript-1">
    <DisplayName>JavaScript 1</DisplayName>
    <Properties>
        <Property name="propName">propertyValue</Property>
    </Properties>
    <SSLInfo>
        <Enabled>trueFalse</Enabled>
        <ClientAuthEnabled>trueFalse</ClientAuthEnabled>
        <KeyStore>ref://keystoreRef</KeyStore>
        <KeyAlias>keyAlias</KeyAlias>
        <TrustStore>ref://truststoreRef</TrustStore>
    </SSLInfo>
    <IncludeURL>jsc://a-javascript-library-file</IncludeURL>
    <ResourceURL>jsc://my-javascript-source-file</ResourceURL>
    <Source>insert_js_code_here</Source>

</Javascript>

Attributi <Javascript>

<Javascript name="Javascript-1" enabled="true" continueOnError="false" async="false" timeLimit="200">

I seguenti attributi sono specifici di questa policy.

La tabella seguente descrive gli attributi comuni a tutti gli elementi principali del criterio:

&lt;DisplayName&gt; elemento

Da utilizzare in aggiunta all'attributo name per etichettare il criterio in editor proxy della UI di gestione con un nome diverso e in linguaggio naturale.

<DisplayName>Policy Display Name</DisplayName>

Elemento <IncludeURL>

Specifica un file di libreria JavaScript da caricare come dipendenza del file JavaScript principale specificato con l'elemento <ResourceURL> o <Source>. Gli script verranno valutati nell' ordine in cui sono elencati nella policy. Il codice può utilizzare gli oggetti, i metodi e le proprietà del modello oggetto JavaScript.

Includi più di una risorsa di dipendenza JavaScript con elementi <IncludeURL> aggiuntivi.

<IncludeURL>jsc://my-javascript-dependency.js</IncludeURL>

Esempio

Vedi l'esempio di base nella sezione Esempi.

Elemento <Property>

Specifica una proprietà a cui puoi accedere dal codice JavaScript in fase di runtime.

<Properties>
    <Property name="propName">propertyValue</Property>
</Properties>

Attributi

Esempio

Vedi l'esempio nella sezione Esempi.

Elemento <ResourceURL>

Specifica il file JavaScript principale che verrà eseguito nel flusso API. Puoi archiviare questo file nell'ambito del proxy API (in /apiproxy/resources/jsc nel bundle proxy API o nella sezione Script del riquadro Navigatore dell'editor proxy API) oppure negli ambiti dell'organizzazione o dell'ambiente per il riutilizzo in più proxy API, come descritto in File di risorse. Il codice può utilizzare gli oggetti, metodi e le proprietà del modello oggetto JavaScript.

<ResourceURL>jsc://my-javascript.js</ResourceURL>

Esempio

Vedi l'esempio di base nella sezione Esempi.

Elemento <Source>

Ti consente di inserire JavaScript direttamente nella configurazione XML della policy. Il codice JavaScript inserito viene eseguito quando la policy viene eseguita nel flusso API.

Esempio

<Javascript name='JS-ParseJsonHeaderFullString' timeLimit='200' >
  <Properties>
    <Property name='inboundHeaderName'>specialheader</Property>
    <Property name='outboundVariableName'>json_stringified</Property>
  </Properties>
  <Source>
var varname = 'request.header.' + properties.inboundHeaderName + '.values.string';
var h = context.getVariable(varname);
if (h) {
  h = JSON.parse(h);
  h.augmented = (new Date()).valueOf();
  var v = JSON.stringify(h, null, 2) + '\n';
  // further indent
  var r = new RegExp('^(\S*)','mg');
  v= v.replace(r,'    $1');
  context.setVariable(properties.outboundVariableName, v);
}
  </Source>
</Javascript>

Elemento <SSLInfo>

Specifica le proprietà utilizzate per configurare TLS per tutte le istanze del client HTTP create dalla policy JavaScript.

    <SSLInfo>
        <Enabled>trueFalse</Enabled>
        <ClientAuthEnabled>trueFalse</ClientAuthEnabled>
        <KeyStore>ref://keystoreRef</KeyStore>
        <KeyAlias>keyAlias</KeyAlias>
        <TrustStore>ref://truststoreRef</TrustStore>
    </SSLInfo>

La procedura di configurazione di TLS per un client HTTP è la stessa che utilizzi per configurare TLS per un TargetEndpoint/TargetServer. Per ulteriori informazioni, vedi Configurare TLS da Edge al backend.

Note sull'utilizzo

Una policy JavaScript non contiene codice effettivo. Al contrario, una policy JavaScript fa riferimento a una "risorsa" JavaScript e definisce il passaggio nel flusso API in cui viene eseguito JavaScript. Puoi caricare lo script tramite l'editor proxy dell'interfaccia utente di gestione oppure puoi includerlo nella /resources/jsc directory nei proxy API che sviluppi localmente.

Eseguire il debug del codice della policy JavaScript

Utilizza la funzione print() per generare informazioni di debug nel riquadro di output della transazione nello strumento Trace. Per dettagli ed esempi, vedi Eseguire il debug con le istruzioni print() di JavaScript.

Per visualizzare le istruzioni di stampa in Trace:

1. Apri lo strumento Trace e avvia una sessione di traccia per un proxy che contiene la policy JavaScript.
2. Chiama il proxy.
3. Nello strumento Trace, fai clic su Output da tutte le transazioni per aprire il riquadro di output.

   

4. Le istruzioni di stampa verranno visualizzate in questo riquadro.

Puoi utilizzare la funzione print() per generare informazioni di debug nello strumento Trace. Questa funzione è disponibile direttamente tramite il modello oggetto JavaScript. Per maggiori dettagli, vedi "Eseguire il debug di JavaScript con le istruzioni print() statements".

Variabili di flusso

Per impostazione predefinita, questa policy non popola alcuna variabile; tuttavia, puoi impostare (e ottenere) le variabili di flusso nel codice JavaScript chiamando i metodi sull'oggetto context. Un pattern tipico è il seguente:

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

L'oggetto context fa parte del modello oggetto JavaScript di Apigee Edge.

Messaggi di errore

Questa sezione descrive i codici e i messaggi di errore restituiti, nonché le variabili di errore. impostate da Edge quando questo criterio attiva un errore. È importante conoscere queste informazioni se stai sviluppando regole di errore per gestire gli errori. Per saperne di più, consulta Cosa devi sapere sugli errori relativi ai criteri e sulla gestione di errore.

Errori di runtime

Questi errori possono verificarsi quando il criterio viene eseguito.

Errori di deployment

Questi errori possono verificarsi quando esegui il deployment di un proxy contenente questo criterio.

Variabili di errore

Queste variabili vengono impostate quando il criterio attiva un errore in fase di runtime. Per ulteriori informazioni, consulta Cosa che devi conoscere sugli errori relativi alle norme.

Esempio di risposta di errore

{
  "fault": {
    "faultstring": "Execution of SetResponse failed with error: Javascript runtime error: "ReferenceError: "status" is not defined. (setresponse.js:6)\"",
    "detail": {
      "errorcode": "steps.javascript.ScriptExecutionFailed"
    }
  }
}

Esempio di regola di errore

<FaultRule name="JavaScript Policy Faults">
    <Step>
        <Name>AM-CustomErrorResponse</Name>
        <Condition>(fault.name Matches "ScriptExecutionFailed") </Condition>
    </Step>
    <Condition>(javascript.JavaScript-1.failed = true) </Condition>
</FaultRule>

Schema

Ogni tipo di policy è definito da uno schema XML (.xsd). Per riferimento, gli schemi delle policy sono disponibili su GitHub.

Argomenti correlati

• Modello oggetto JavaScript
• Per istruzioni, esempi di policy ed esempi di JavaScript, vedi Programmare proxy API proxy con JavaScript.

Articoli della community di Apigee

Puoi trovare questi articoli correlati nella community di Apigee:

• How to handle multi-value headers in Javascript?