خط مشی 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 یک جریان مشترک را فراخوانی می کند که برای انجام توابع رایج مدیریت رشته طراحی شده است. جریان مشترک شامل جاوا اسکریپت است که ورودی آن، حروف کوچک ورودی آن یا هر دو را به هم متصل می کند. خط مشی 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 است که زمانی اجرا می‌شود که جریان مشترک از یک خط‌مشی FlowCallout فراخوانی شود.

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

3. در جریان مشترک، خط مشی جاوا اسکریپت SharedStringFunctions زیر فایل جاوا اسکریپت 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. جاوا اسکریپت زیر، SharedStringFunctions.js، از خط مشی جاوا اسکریپت 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. اجرا از خط مشی جاوا اسکریپت به جریان مشترک و سپس به خط مشی 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>