FlowCallout 政策

在共享流中验证 API 密钥

在此示例中，共享流用于执行与安全相关的常见任务。此处，共享流程会验证 API 密钥。API 代理和其他共享流可以使用 FlowCallout 政策调用此共享流。

以下共享流定义包括 Verify-API-Key 政策，该政策在从 API 代理中的 FlowCallout 政策调用共享流时执行。

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

上述的共享流中的 VerifyAPIKey 政策可检索键值对并对其进行验证。

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

以下 API 代理中使用的 FlowCallout 政策会调用上述共享流来验证 API 密钥。verify-apikey-shared 共享流软件包（此处未显示）以 APIProxy 软件包配置代理的方式配置共享流。

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

将参数传递到共享流

此示例展示了如何将 FlowCallout 政策的参数传递到共享流。此处，FlowCallout 政策会调用旨在执行通用字符串处理函数的共享流。共享流包括用于连接其输入、小写其输入或者同时执行两个操作的 JavaScript。FlowCallout 政策定义用于指定字符串输入和输出的参数以及处理输入参数方式。

1. String-Handler FlowCallout 政策会调用共享流，传递参数以指定用于存储共享流输出的变量、共享流使用的操作以及要使用的输入（此处为字符串字面量，但也可能是流变量）。Parameter 元素指定创建运行时的变量的名称和值。共享流可以检索这些变量，以便在自己的代码中使用。

   <?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. 以下 default 共享流包含一个 SharedStringFunctions JavaScript 政策，该政策会在从 FlowCallout 政策调用共享流时执行。

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

3. 在共享流中，以下 SharedStringFunctions JavaScript 政策可指定 SharedStringFunctions.js JavaScript 文件以及要执行的代码。

   <?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. 以下 JavaScript、SharedStringFunctions.js 执行 SharedStringFunctions JavaScript 政策。此脚本从 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. 执行会从 JavaScript 政策流向共享流，再流向源 API 代理中的 FlowCallout 政策。

语法

您可以将此元素与以下任何一种语法形式搭配使用。请注意，使用字面量值时，您指定的值的格式将取决于使用该值的代码。

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

示例

此 String-Handler FlowCallout 政策会传递参数，该参数用于指定存储共享流输出的位置以及要使用的输入。Parameter 元素指定创建运行时的变量的名称和值。共享流可以检索这些变量，以便在自己的代码中使用。

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

语法

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