Règle FlowCallout

Valider la clé API dans un flux partagé

Dans cet exemple, un flux partagé est utilisé pour effectuer des tâches courantes liées à la sécurité. Ici, le flux partagé valide une clé API. Les proxys d'API et d'autres flux partagés peuvent utiliser la règle FlowCallout pour effectuer des appels dans ce flux partagé.

La définition de flux partagé suivante inclut une règle Verify-API-Key qui s'exécute lorsque le flux partagé est appelé à partir d'une règle FlowCallout dans un proxy d'API.

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

La règle VerifyAPIKey dans le flux partagé précédent récupère la valeur de la clé et la vérifie.

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

La règle FlowCallout suivante, utilisée dans un proxy d'API, appelle le flux partagé précédent pour vérifier la clé API. Le groupe de flux partagés verify-apikey-shared (non illustré ici) configure le flux partagé de la même manière qu'un groupe APIProxy configure un proxy.

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

Transmettre des paramètres à un flux partagé

Cet exemple montre comment transmettre des paramètres d'une règle FlowCallout à un flux partagé. Ici, une règle FlowCallout appelle un flux partagé conçu pour effectuer des fonctions courantes de traitement de chaînes. Le flux partagé inclut du code JavaScript qui concatène les entrées, ou ne prend pas en compte les entrées. La règle FlowCallout définit les paramètres qui spécifient l'entrée de chaîne, la sortie de chaîne et le traitement qu'il convient d'appliquer à l'entrée.

1. La règle String-Handler FlowCallout appelle le flux partagé, en transmettant des paramètres qui spécifient la variable afin de stocker la sortie du flux partagé, l'opération de flux partagé et l'entrée à utiliser (ici, un littéral de chaîne, mais Il peut également s'agir d'une variable de flux). Les éléments Parameter spécifient les noms et les valeurs des variables à créer. Le flux partagé peut récupérer ces variables pour les utiliser dans son propre code.

   <?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. Le flux partagé default suivant inclut une stratégie JavaScript SharedStringFunctions qui s'exécute lorsque le flux partagé est appelé à partir d'une règle FlowCallout.

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

3. Dans le flux partagé, la règle JavaScript SharedStringFunctions suivante spécifie le fichier JavaScript SharedStringFunctions.js avec le code à exécuter.

   <?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. Le code JavaScript suivant, SharedStringFunctions.js, s'exécute à partir de la règle JavaScript SharedStringFunctions. Ce script récupère les valeurs depuis les variables créées à partir des éléments Parameter de la règle 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'exécution est renvoyée à partir de la règle JavaScript vers le flux partagé, puis à la règle FlowCallout dans le proxy d'API d'origine.

Syntaxe

Vous pouvez utiliser cet élément avec l'une des formes de syntaxe suivantes. Notez que lorsque vous spécifiez une valeur littérale, le format de la valeur que vous spécifiez dépend du code qui l'utilise.

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

Exemple

La règle FlowCallout String-Handler transmet des paramètres qui spécifient où stocker le résultat du flux partagé et l'entrée à utiliser. Les éléments Parameter spécifient les noms et les valeurs des variables pour créer l'environnement d'exécution. Le flux partagé peut récupérer ces variables pour les utiliser dans leur propre code.

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

Syntaxe

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