Criterio FlowCallout

Verificare la chiave API nel flusso condiviso

In questo esempio, un flusso condiviso viene utilizzato per eseguire attività comuni correlate alla sicurezza. Qui il flusso condiviso convalida una chiave API. I proxy API e altri flussi condivisi possono utilizzare 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 flussi condivisi verify-apikey-shared (non mostrato qui) configura il flusso condiviso nello stesso 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 mostra come passare i parametri da un criterio FlowCallout a un flusso condiviso. In questo caso, un criterio FlowCallout chiama un flusso condiviso progettato per eseguire funzioni comuni di gestione delle stringhe. Il flusso condiviso include JavaScript che concatena l'input, lo converte in minuscolo o entrambi. Il criterio FlowCallout definisce i parametri che specificano l'input della stringa, l'output e cosa fare con l'input.

1. Il criterio FlowCallout String-Handler chiama il flusso condiviso, passando i parametri che specificano la variabile in cui memorizzare l'output del flusso condiviso, l'operazione del flusso condiviso da utilizzare e l'input da utilizzare (in questo caso, un valore letterale stringa, ma potrebbe anche essere una variabile di flusso). Gli elementi Parameter specificano i nomi e i valori delle variabili da creare in fase di 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 SharedStringFunctions criterio JavaScript 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 JavaScript, SharedStringFunctions.js, viene eseguito dal SharedStringFunctions criterio JavaScript. Questo script recupera i valori dalle variabili create dagli elementi Parameter del criterio FlowCallout.

   // 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, quindi al criterio FlowCallout nel proxy API di origine.

Sintassi

Puoi utilizzare questo elemento con una delle seguenti forme di sintassi. Tieni presente che, quando utilizzi un valore letterale, il formato del valore specificato dipende 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 FlowCallout String-Handler passa i parametri che specificano dove memorizzare l'output del flusso condiviso e quale input utilizzare. Gli elementi Parameter specificano i nomi e i valori delle variabili da creare in fase di 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>

Sintassi

<Parameters>
  <Parameter name="parameter-name" value='parameter-value' />
</Parameters>