流程呼叫政策

在共用流程中驗證 API 金鑰

在這個範例中，共用流程用於執行常見的安全性相關工作。這裡的共用流程會驗證 API 金鑰。API Proxy 和其他共用流程可以使用 FlowCallout 政策呼叫這個共用流程。

下列共用流程定義包含 Verify-API-Key 政策，當 API Proxy 中的 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 Proxy 中使用下列 FlowCallout 政策，呼叫上述共用流程來驗證 API 金鑰。verify-apikey-shared 共用流程套件 (此處未顯示) 會設定共用流程，方式與 APIProxy 套件設定 Proxy 相同。

<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 Proxy 中的 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>