Política de FlowCallout

Verifica la clave de API en el flujo compartido

En este ejemplo, se usa un flujo compartido para realizar tareas comunes relacionadas con la seguridad. Aquí, el flujo compartido valida una clave de API. Los proxies de API y otros flujos compartidos política para realizar llamadas a este flujo compartido.

La siguiente definición de flujo compartido incluye una política de Verify-API-Key que se ejecuta cuando se llama al flujo compartido desde una política de FlowCallout en un proxy de API.

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

La política VerifyAPIKey dentro del flujo compartido anterior recupera el valor de clave y lo verifica.

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

La siguiente política Flow mejorado, que se usa en un proxy de API, llama al flujo compartido anterior para que verificar la clave de API. El paquete de flujo compartido verify-apikey-shared (no se muestra aquí) configura el flujo compartido de la misma forma en que un paquete de 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>

Cómo pasar parámetros a un flujo compartido

En este ejemplo, se ilustra cómo pasar parámetros de una política FlowTexto a una flujo compartido. En este caso, una política Flow mejorado llama a un flujo compartido diseñado para realizar acciones las funciones de manejo de cadenas. El flujo compartido incluye JavaScript que concatena su entrada, escribe su entrada en minúsculas o ambas. La política Flow mejorado define los parámetros que especifican la entrada de cadena, la salida y qué hacer con la entrada.

1. La política Flow conformidad String-Handler llama al flujo compartido, parámetros que especifican la variable para almacenar la salida del flujo compartido, operación y qué entrada usar (aquí, un literal de cadena, pero también podría ser de flujo). Los elementos Parameter especifican los nombres y valores de las variables para crear un entorno de ejecución. El flujo compartido puede recuperar estas variables para usarlas en su propio código.

   <?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. El siguiente flujo compartido default incluye una política de JavaScript SharedStringFunctions que se ejecuta cuando se llama al flujo compartido desde una política de FlowCallout.

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

3. En el flujo compartido, la siguiente política de JavaScript SharedStringFunctions especifica el archivo de JavaScript SharedStringFunctions.js con el código que se ejecutará.

   <?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. El siguiente JavaScript, SharedStringFunctions.js, se ejecuta desde el Política de JavaScript de SharedStringFunctions. Esta secuencia de comandos recupera valores de Variables creadas a partir de los elementos Parameter de la política Flow conformidad.

   // 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. La ejecución fluye de la política de JavaScript al flujo compartido y, luego, a la política de FlowCallout en el proxy de API de origen.

Sintaxis

Puedes usar este elemento con cualquiera de las siguientes formas de sintaxis. Ten en cuenta que, cuando usas un valor literal, el formato del valor que especifiques dependerá del código que lo consume.

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

Ejemplo

Esta política FlowTexto de String-Handler pasa parámetros que especifican dónde para almacenar la salida del flujo compartido y qué entrada usar. Los elementos Parameter especificar los nombres y valores de las variables para crear un entorno de ejecución. El flujo compartido puede recuperar estas variables para usarlas en su propio código.

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

Sintaxis

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