Правила в отношении выносок в потоке

Как подтвердить ключ API в общем потоке

В этом примере общий поток используется для выполнения стандартных задач, связанных с безопасностью. В этом случае общий поток проверяет ключ API. Прокси API и другие общие потоки могут использовать правило FlowCallout для вызова этого общего потока.

В приведенном ниже определении общего потока содержится правило Verify-API-Key, которое выполняется, когда общий поток вызывается из правила FlowCallout в прокси-сервере API.

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

Следующее правило FlowCallout, используемое в прокси-сервере API, вызывает предыдущий общий поток для проверки ключа 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. В общем потоке следующее правило JavaScript SharedStringFunctions указывает на файл JavaScript SharedStringFunctions.js с кодом для выполнения.

   <?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, выполняется в соответствии с правилом JavaScript SharedStringFunctions. Этот скрипт извлекает значения из переменных, созданных на основе элементов правила "Выноска с переходом" 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 в общий поток, а затем в правило FlowCallout в исходном прокси-сервере API.

Синтаксис

Этот элемент можно использовать с любым из следующих вариантов синтаксиса. Обратите внимание, что если вы используете литеральное значение, его формат будет зависеть от кода, который его обрабатывает.

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