Norme di FlowCallout

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza documentazione di Apigee Edge.

icona norme

Utilizza il criterio FlowCallout per richiamare un flusso condiviso da un proxy API o da un altro un flusso condiviso.

In un flusso condiviso, crei una sequenza di passaggi che puoi riutilizzare in fase di esecuzione da più luoghi. Questi passaggi sono implementati come criteri, ad esempio all'interno di un proxy API. Il criterio FlowCallout ti consente di richiamare il flusso condiviso dai proxy API e da altri flussi condivisi. Funziona come una chiamata di funzione in un linguaggio di programmazione tradizionale.

  • Ad esempio, immagina di aver creato un flusso condiviso con funzionalità di sicurezza come Verifica delle chiavi API, convalida del token OAuth e protezione tramite espressioni regolari. Questo flusso condiviso rappresenta la convenzione per un modo per controllare le richieste in entrata. Utilizzando i criteri FlowCallout, puoi richiamare il flusso condiviso da più proxy API.
  • Puoi chiamare un flusso condiviso da un altro implementando un criterio FlowCallout dall'interno di un flusso condiviso.

Questo criterio è un criterio estensibile e il suo utilizzo potrebbe comportare implicazioni in termini di costi o utilizzo, a seconda della licenza Apigee. Per informazioni sui tipi di criteri e sulle implicazioni per l'utilizzo, consulta Tipi di criteri.

Esempi

Verifica la chiave API nel flusso condiviso

In questo esempio viene utilizzato un flusso condiviso per eseguire attività comuni correlate alla sicurezza. Qui il flusso condiviso convalida una chiave API. I proxy API e altri flussi condivisi possono utilizzare FlowCallout per effettuare chiamate in questo flusso condiviso.

La seguente definizione di flusso condiviso include un criterio Verify-API-Key che viene eseguito quando il flusso condiviso viene chiamato da un criterio FlowCallout in un proxy API.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<SharedFlow name="default">
    <Step>
        <Name>Verify-API-Key</Name>
    </Step>
</SharedFlow>

Il criterio VerifyAPIKey nel flusso condiviso precedente recupera il valore della chiave e lo verifica.

<VerifyAPIKey async="false" continueOnError="false" enabled="true" name="Verify-API-Key">
    <DisplayName>Verify API Key</DisplayName>
    <APIKey ref="request.queryparam.apikey"/>
</VerifyAPIKey>

Il seguente criterio FlowCallout, usato in un proxy API, chiama la precedente un flusso condiviso per verificare la chiave API. Il bundle di flussi condivisi verify-apikey-shared (non mostrato qui) configura il flusso condiviso nel modo in cui un bundle APIProxy configura un proxy.

<FlowCallout async="false" continueOnError="false" enabled="true" name="Auth-Flow-Callout">
    <DisplayName>Auth Flow Callout</DisplayName>
    <SharedFlowBundle>verify-apikey-shared</SharedFlowBundle>
</FlowCallout>

Passare i parametri a un flusso condiviso

Questo esempio illustra come passare i parametri da un criterio FlowCallout a un flusso condiviso. In questo caso, un criterio FlowCallout richiama un flusso condiviso progettato per eseguire funzioni comuni di gestione delle stringhe. Il flusso condiviso include JavaScript che concatena il suo input, il suo input in minuscolo, o entrambi. Il criterio FlowCallout definisce i parametri che specificano l'input e l'output della stringa e cosa fare con l'input.

  1. Il criterio String-Handler FlowCallout chiama il flusso condiviso, passando i parametri che specificano la variabile per memorizzare l'output del flusso condiviso, l'operazione del flusso condiviso da utilizzare e l'input da utilizzare (qui una stringa letterale, ma potrebbe anche essere una variabile di flusso). Gli elementi Parameter specificano i nomi e i valori delle variabili per creare il runtime. Il flusso condiviso può recuperare queste variabili per utilizzarle nel proprio codice.

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<FlowCallout async="false" continueOnError="false" enabled="true" name="String-Handler">
  <DisplayName>String Handler</DisplayName>
  <Parameters>
    <Parameter name="input">Gladys Kravitz</Parameter>
    <Parameter name="operations">concatenate tolowercase</Parameter>
    <Parameter name="outputVariable">string.handler.output</Parameter>
  </Parameters>
  <SharedFlowBundle>StringHandler</SharedFlowBundle>
</FlowCallout>

  2. Il seguente flusso condiviso default include un criterio JavaScript SharedStringFunctions che viene eseguito quando il flusso condiviso viene chiamato da un criterio FlowCallout.

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<SharedFlow name="default">
  <Step>
    <Name>SharedStringFunctions</Name>
  </Step>
</SharedFlow>

  3. Nel flusso condiviso, il seguente criterio JavaScript SharedStringFunctions specifica il file JavaScript SharedStringFunctions.js con il codice da eseguire.

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

  4. Il seguente codice JavaScript, SharedStringFunctions.js, viene eseguito SharedStringFunctions criterio JavaScript. Questo script recupera i valori dalle variabili create dagli elementi FlowCallout criterio Parameter.

    // Input value from the calling API proxy.
var handledString = context.getVariable("input");
// Variable to use for output from this script.
var outputVariable = context.getVariable("outputVariable");
// A space-separated list of things to do to the input string.
// Convert to lower case to handle unintentional capitals in configuration.
var operation = context.getVariable("operations").toLowerCase();

// If "lowercase" was given as an operation, convert the input to lowercase.
if (operation.includes("tolowercase")) {
    handledString = handledString.toLowerCase();
}

// If "concatenate" was given as an operation, concatenate the input.
if (operation.includes("concatenate")) {
    handledString = handledString.replace(/\s+/g, '');
}
// Assign the resulting string to the output variable specified by
// the calling API proxy.
context.setVariable(outputVariable, handledString);
  5. L'esecuzione torna dal criterio JavaScript al flusso condiviso e poi al criterio FlowCallout nel proxy API di origine.

Riferimento elemento

Di seguito sono riportati gli elementi e gli attributi che puoi configurare su questo criterio:

<FlowCallout async="false" continueOnError="false" enabled="true" name="Flow-Callout-1">
    <DisplayName>Custom label used in UI</DisplayName>
    <SharedFlowBundle>thereferencedsharedflowbundle</SharedFlowBundle>
</FlowCallout>

&lt;FlowCallout&gt; attributi

<FlowCallout async="false" continueOnError="false" enabled="true" name="Flow-Callout-1">

La tabella seguente descrive gli attributi comuni a tutti gli elementi principali dei criteri:

Attributo Descrizione Predefinito Presenza
name

Il nome interno del criterio. Il valore dell'attributo name può Deve contenere lettere, numeri, spazi, trattini, trattini bassi e punti. Questo valore non può superare i 255 caratteri.

Se vuoi, utilizza l'elemento <DisplayName> per etichettare il criterio nell'editor proxy dell'interfaccia utente di gestione con un nome diverso in linguaggio naturale.

 N/D Obbligatorio
continueOnError

Imposta il valore su false per restituire un errore quando un criterio non funziona. Si tratta di un comportamento previsto comportamento per la maggior parte dei criteri.

Imposta su true per continuare l'esecuzione del flusso anche dopo un fallimento del criterio. Vedi anche:

 falso Facoltativo
enabled

Imposta su true per applicare il criterio.

Imposta false per disattivare il criterio. Il criterio non verrà applicata anche se rimane collegata a un flusso.

 true Facoltativo
async

Questo attributo è stato ritirato.

 falso Ritirato

&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>
Predefinito

N/D

Se ometti questo elemento, il valore dell'attributo name del criterio è in uso.
Presenza Facoltativo
Tipo Stringa

&lt;SharedFlowBundle&gt; elemento

Specifica il nome del flusso condiviso da chiamare. Il valore di questo elemento deve essere uguale al valore valore dell'attributo nome dell'elemento <SharedFlowBundle> target.

<SharedFlowBundle/>

Nell'esempio più semplice, fornisci il nome del flusso condiviso chiamato come valore per questo elemento. In altre parole, il valore di questo elemento deve essere uguale al valore dell'attributo name del flusso condiviso.

<SharedFlowBundle>Shared-Flow-Name</SharedFlowBundle>
Predefinito N/D
Presenza Obbligatorio
Tipo N/D

Attributi

Nessuno.

&lt;Parameter&gt; elemento

Specifica un parametro e un valore (o un'origine valore) da passare come variabile al flusso condiviso chiamato da questo criterio.

Utilizzando un parametro, puoi specificare un valore (o una variabile contenente un valore) da passare al flusso condiviso chiamato dal criterio. È concettualmente simile alla specifica di un parametro in una chiamata di funzione. Come per il parametro di una funzione, il valore di un parametro FlowCallout può variano in base al contesto della chiamata a un flusso condiviso.

I parametri FlowCallout sono visibili solo durante l'esecuzione del flusso condiviso.

Sintassi

Puoi utilizzare questo elemento con una delle seguenti forme di sintassi. Tieni presente che se utilizzi un valore letterale, il formato del valore specificato dipenderà dal codice che lo utilizza.

<!- A literal value in an attribute. --/>
<Parameter name="parameter-name" value='parameter-value' />
<!- A reference to a variable in an attribute. --/>
<Parameter name="parameter-name" ref='source-variable-name' />
<!- A literal value in the element content. --/>
<Parameter name="parameter-name">parameter-value</Parameter>
<!- An reference to an attribute in the element content. --/>
<Parameter name="parameter-name">{source-variable-name}</Parameter>

Esempio

Questo criterio String-Handler FlowCallout passa parametri che specificano dove memorizzare l'output del flusso condiviso e quale input utilizzare. Gli elementi Parameter e specificare i nomi e i valori delle variabili per creare il runtime. Il flusso condiviso può recuperare queste variabili per utilizzarle nel proprio codice.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<FlowCallout async="false" continueOnError="false" enabled="true" name="String-Handler">
  <DisplayName>String Handler</DisplayName>
  <Parameters>
    <Parameter name="input">Gladys Kravitz</Parameter>
    <Parameter name="outputVariable">string.handler.output</Parameter>
  </Parameters>
  <SharedFlowBundle>StringHandler</SharedFlowBundle>
</FlowCallout>
Predefinito N/D
Presenza Obbligatorio
Tipo N/D

Attributi

Attributo Descrizione Predefinito Presenza Tipo
name Il nome della variabile di runtime da creare con questo parametro. Nessuno Obbligatorio Stringa
ref

La variabile che contiene il valore da utilizzare in fase di esecuzione. Ometti questo attributo se stai che specifica un valore letterale da utilizzare.

 Nessuno Facoltativo Stringa
value Il valore da utilizzare nella variabile di runtime creata con questo parametro. Ometti questo attributo se specifichi il nome di una variabile che dovrebbe essere l'origine valore. Nessuno Facoltativo Stringa

Elemento <Parameters>

Specifica l'insieme di elementi <Parameter> da passare come variabili nel flusso condiviso chiamato da questo criterio.

Sintassi

<Parameters>
  <Parameter name="parameter-name" value='parameter-value' />
</Parameters>
Predefinito N/D
Presenza Facoltativo
Tipo N/D

Attributi

Nessuno.

Schemi

Variabili di flusso

Le variabili di flusso consentono il comportamento dinamico di criteri e flussi in fase di runtime, in base a HTTP intestazioni, contenuti dei messaggi o contesto del flusso. Per ulteriori informazioni sulle variabili di flusso, consulta Riferimento per le variabili.

Variabile Descrizione

apigee.edge.sharedflow.name

Ambito: durante l'esecuzione del flusso condiviso
Tipo: stringa
Autorizzazione: lettura

Il valore dell'attributo name del flusso condiviso.

apigee.edge.flowhook.name

Ambito: durante l'esecuzione del flusso condiviso collegato al flusso hook.
Tipo: stringa
Autorizzazione: Lettura

Il nome dell'hook di flusso.

Messaggi di errore

Questa sezione descrive i codici e i messaggi di errore restituiti e le variabili di errore impostate da Apigee quando questo criterio attiva un errore. Queste informazioni sono importanti per sapere se si stanno sviluppando regole di errore per la gestione degli errori. Per scoprire di più, consulta gli articoli Cosa devi sapere sugli errori relativi alle norme e Gestione degli errori.

Errori di runtime

Questi errori possono verificarsi quando il criterio viene eseguito.

Codice di errore Stato HTTP Causa Correggi
flow.SharedFlowNotFound 500 Il flusso condiviso non esiste oppure il flusso condiviso esiste, ma non è stato eseguito il deployment.

Errori di deployment

N/A

Argomenti correlati