Политика FlowCallout

Проверка ключа 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 включает политику JavaScript SharedStringFunctions , которая выполняется, когда общий поток вызывается из политики 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 политики 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. Выполнение возвращается из политики 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>