Norme JavaScript

Stai visualizzando la documentazione di Apigee Edge.
Vai alla sezione Documentazione di Apigee X. Informazioni

Cosa

Questo criterio consente di aggiungere codice JavaScript personalizzato che viene eseguito nel contesto di un'API flusso proxy. Nel codice JavaScript personalizzato, puoi utilizzare gli oggetti, i metodi e le proprietà il modello a oggetti JavaScript di Apigee Edge. Il modello a oggetti consente di ottenere, impostare e rimuovere variabili nel contesto del flusso proxy. Tu può anche utilizzare le funzioni crittografiche di base fornite con il modello a oggetti.

Informazioni

Esistono molti casi d'uso per il criterio JavaScript. Ad esempio, puoi ottenere e impostare il flusso variabili, eseguire logica personalizzata e gestire gli errori, estrarre i dati dalle richieste le risposte, modificare dinamicamente l'URL di destinazione del backend e altro ancora. Questo criterio consente di implementare un comportamento personalizzato che non sia coperto da altri criteri Edge standard. Infatti, è possibile usare un criterio JavaScript per ottenere molti degli stessi comportamenti implementati da altri criteri, comeAssignMessage ed ExtractVariable.

Un caso d'uso che non consigliamo per il criterio JavaScript è il logging. Il criterio di logging dei messaggi è molto più adatto per il logging su piattaforme di logging di terze parti come Splunk, Sumo e Loggly, puoi migliorare le prestazioni del proxy API eseguendo il criterio di logging dei messaggi in PostClientFlow, che viene eseguita dopo che la risposta è stata inviata al client.

Il criterio JavaScript consente di specificare un file di origine JavaScript da eseguire o puoi includere il codice JavaScript direttamente nella configurazione del criterio con <Source> . In ogni caso, il codice JavaScript viene eseguito quando viene eseguito il passaggio a cui è associato il criterio. Per l'opzione File sorgente, il codice sorgente è sempre archiviato in un posizione standard all'interno del bundle proxy: apiproxy/resources/jsc. In alternativa, puoi anche e archiviare il codice sorgente in un file di risorse a livello di ambiente o organizzazione. Per istruzioni, vedi File di risorse. Puoi e caricare il codice JavaScript tramite l'editor proxy della UI di Apigee.

I file sorgente JavaScript devono avere sempre un'estensione .js.

Vedi Software supportati e versioni supportate per la versione attualmente supportata di JavaScript.

Video

Guarda un breve video per imparare a creare un'estensione di una norma personalizzata utilizzando 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 agli elementi descrive gli elementi e gli attributi del criterio 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>

<Javascript> Attributi

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

Gli attributi riportati di seguito sono specifici di questo criterio.

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

<DisplayName> 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>

<IncludeURL> elemento

Specifica un file della libreria JavaScript da caricare come dipendenza dal file JavaScript principale specificato con l'elemento <ResourceURL> o <Source>. Gli script verranno valutati nell'ordine in cui sono elencati nelle norme. Il codice può utilizzare oggetti, metodi del modello a oggetti JavaScript.

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

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

Esempio

Consulta l'esempio di base nella sezione Samples.

<Property> elemento

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

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

Attributi

Esempio

Guarda l'esempio nella sezione Samples.

<ResourceURL> elemento

Specifica il file JavaScript principale che verrà eseguito nel flusso dell'API. Puoi archiviare questo file nell'ambito del proxy API (in /apiproxy/resources/jsc nel bundle proxy API o sezione Script del riquadro di navigazione dell'editor proxy API) o a livello di organizzazione Ambiti di ambiente da riutilizzare in più proxy API, come descritto in File di risorse. Il codice può utilizzare gli oggetti, metodi e proprietà del modello a oggetti JavaScript.

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

Esempio

Consulta l'esempio di base nella sezione Samples.

<Source> elemento

Consente di inserire JavaScript direttamente nella configurazione XML del criterio. Il valore inserito Il codice JavaScript viene eseguito quando il criterio viene eseguito nel flusso dell'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>

<SSLInfo> elemento

Specifica le proprietà utilizzate per configurare TLS per tutte le istanze del client HTTP create dal criterio 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. Vedi Configurazione di TLS da Edge al backend per ulteriori informazioni.

Note sull'utilizzo

Un criterio JavaScript non contiene codice effettivo. Un criterio JavaScript fa invece riferimento a un "resource" JavaScript e definisce il passaggio nel flusso dell'API in cui viene eseguito JavaScript. Puoi Caricare lo script tramite l'editor proxy dell'interfaccia utente di gestione oppure includerlo nella Directory /resources/jsc nei proxy API che sviluppi localmente.

Debug del codice del criterio JavaScript

Utilizza la funzione print() per restituire le informazioni di debug alla transazione nello strumento Trace. Per dettagli ed esempi, vedi Debug con JavaScript print().

Per visualizzare le istruzioni di stampa in Trace:

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

   

4. Gli estratti conto cartacei verranno visualizzati in questo riquadro.

Puoi utilizzare la funzione Print() per inviare le informazioni di debug allo strumento Traccia. Questa funzione è disponibile direttamente attraverso il modello a oggetti JavaScript. Per maggiori dettagli, consulta "Eseguire il debug di JavaScript con stampa() ".

Variabili di flusso

Questo criterio non compila le variabili per impostazione predefinita. ma puoi impostare (e ottenere) il flusso nel tuo codice JavaScript richiamando metodi sull'oggetto di contesto. Un modello tipico ha il seguente aspetto:

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

L'oggetto contesto fa parte del modello a oggetti JavaScript di Apigee Edge.

Messaggi di errore

This section describes the fault codes and error messages that are returned and fault variables that are set by Edge when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults.

Runtime errors

These errors can occur when the policy executes.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Fault variables

These variables are set when this policy triggers an error at runtime. For more information, see What you need to know about policy errors.

Example error response

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

Example fault rule

<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 criterio è definito da uno schema XML (.xsd). Come riferimento, consulta gli schemi dei criteri sono disponibili su GitHub.

Argomenti correlati

• Modello a oggetti JavaScript
• Per istruzioni, esempi di criteri ed esempi JavaScript, consulta API di programmazione con JavaScript.

Articoli della community Apigee

Puoi trovare questi articoli correlati sulla piattaforma Apigee Community:

• Come gestire le intestazioni a più valori in JavaScript?