Norme FlowCallout

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza la documentazione di Apigee Edge.

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

In un flusso condiviso, crei una sequenza di passaggi che puoi riutilizzare in fase di esecuzione da più posizioni. Questi passaggi vengono implementati come criteri, ad esempio all'interno di un proxy API. Il criterio FlowCallout consente di richiamare il flusso condiviso da proxy API e 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 la verifica delle chiavi API, la convalida del token OAuth e la protezione delle espressioni regolari. Questo flusso condiviso rappresenta la tua convenzione per controllare le richieste in entrata. Utilizzando i criteri FlowCallout, puoi richiamare quel 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 estendibile e il suo utilizzo potrebbe avere implicazioni in termini di costi o utilizzo, a seconda della licenza Apigee. Per informazioni sui tipi di criteri e sulle implicazioni di utilizzo, consulta Tipi di criteri.

Nota: per saperne di più sui flussi condivisi, consulta Flussi condivisi riutilizzabili. Puoi anche chiamare un flusso condiviso dall'esterno del codice proxy API per applicare la pre-elaborazione delle richieste o la post-elaborazione delle risposte per tutti i proxy API di cui è stato eseguito il deployment in un ambiente. Per saperne di più, consulta Collegare un flusso condiviso utilizzando un hook di flusso.

Esempi

Verifica la chiave API nel flusso condiviso

In questo esempio viene utilizzato un flusso condiviso per eseguire attività comuni relative alla sicurezza. Qui il flusso condiviso convalida una chiave API. I proxy API e altri flussi condivisi possono usare il criterio FlowCallout per effettuare chiamate a 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 all'interno del 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, utilizzato in un proxy API, chiama il flusso condiviso precedente per verificare la chiave API. Il bundle di flusso condiviso 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>

Passaggio dei parametri a un flusso condiviso

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

1. Il criterio FlowCallout String-Handler chiama il flusso condiviso, passando i parametri che specificano la variabile per archiviare l'output del flusso condiviso, quale operazione di flusso condiviso utilizzare e quale input utilizzare (qui, un valore letterale stringa, 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 da utilizzare 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 dal criterio JavaScript SharedStringFunctions. Questo script recupera i valori dalle variabili create dagli elementi del criterio FlowCallout 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 passa 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 per questo criterio:

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

Attributi <FlowCallout>

<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 della norma. Il valore dell'attributo name può contenere lettere, numeri, spazi, trattini, trattini bassi e punti. Questo valore non può superare i 255 caratteri. Facoltativamente, utilizza l'elemento <DisplayName> per etichettare il criterio nell'editor proxy dell'interfaccia utente di gestione con un nome diverso in linguaggio naturale.	N/A	Obbligatorio
continueOnError	Impostalo su false per restituire un errore in caso di errore di un criterio. Questo è il comportamento previsto per la maggior parte dei criteri. Imposta su true per fare in modo che l'esecuzione del flusso continui anche in caso di errore di un criterio. Vedi anche: Le regole di errore vengono attivate SOLO in stato di errore (informazioni su continueOnError) Gestione dei guasti all'interno del flusso di corrente	false	Facoltativo
enabled	Imposta il criterio su true per applicare il criterio. Impostala su false per disattivare il criterio. Il criterio non verrà applicato anche se rimane associato a un flusso.	true	Facoltativo
async	Questo attributo è obsoleto.	false	Deprecata

Elemento <DisplayName>

Utilizzalo in aggiunta all'attributo name per etichettare il criterio nell'editor proxy dell'interfaccia utente di gestione con un nome diverso in linguaggio naturale.

<DisplayName>Policy Display Name</DisplayName>

Predefinito	N/A Se ometti questo elemento, viene utilizzato il valore dell'attributo name del criterio.
Presenza	Facoltativo
Tipo	Stringa

Elemento <SharedFlowBundle>

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

<SharedFlowBundle/>

Nell'esempio più semplice, fornisci il nome del flusso condiviso che viene 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.

Elemento <Parameter>

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

Utilizzando un parametro, puoi specificare un valore (o una variabile contenente un valore) da trasmettere al flusso condiviso chiamato dal criterio. È concettualmente simile a specificare un parametro in una chiamata di funzione. Come nel caso di un parametro di funzione, il valore di un parametro FlowCallout può variare in base al contesto della chiamata del flusso condiviso.

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

Sintassi

Puoi utilizzare questo elemento con una qualsiasi delle seguenti forme di sintassi. Tieni presente che, dove 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 String-Handler FlowCallout criterio di trasmissione dei parametri che specifica dove archiviare l'output del flusso condiviso e quale input utilizzare. 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="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.	Nessun valore	Obbligatorio	Stringa
ref	La variabile che contiene il valore da utilizzare durante l'esecuzione. Ometti questo attributo se stai specificando un valore letterale da utilizzare.	Nessun valore	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 del valore.	Nessun valore	Facoltativo	Stringa

Elemento <Parameters>

Specifica l'insieme di elementi <Parameter> da passare come variabili al 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.

Schema

Esempio: consulta gli esempi del nostro repository GitHub per gli schemi più recenti.

Variabili di flusso

Le variabili di flusso consentono il comportamento dinamico dei criteri e dei flussi in fase di runtime, in base alle intestazioni HTTP, ai contenuti dei messaggi o al contesto del flusso. Per maggiori informazioni sulle variabili di flusso, consulta Riferimento alle variabili.

Variabile	Descrizione
apigee.edge.sharedflow.name	Ambito: durante l'esecuzione del flusso condiviso Tipo: stringa Autorizzazione: lettura Il valore dell'attributo del nome del flusso condiviso.
apigee.edge.flowhook.name	Ambito: durante l'esecuzione del flusso condiviso collegato all'hook di flusso. 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.

Suggerimento: hai bisogno di aiuto per risolvere un errore? Fai clic su nella colonna Correggi per informazioni dettagliate sulla risoluzione dei problemi.

Utilizza Monitoraggio API per esaminare i codici di errore e diagnosticare i problemi più velocemente.

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

• Creazione di flussi condivisi: Flussi condivisi riutilizzabili
• Esecuzione di flussi condivisi su più proxy: collegamento di un flusso condiviso mediante un hook di flusso