خط مشی 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. سیاست FlowCallout مربوط به String-Handler ، جریان مشترک را فراخوانی می‌کند و پارامترهایی را که متغیر مورد نظر برای ذخیره خروجی جریان مشترک، عملیات جریان مشترک مورد استفاده و ورودی مورد استفاده را مشخص می‌کنند، ارسال می‌کند (در اینجا، یک رشته تحت‌اللفظی، اما می‌تواند یک متغیر جریان نیز باشد). عناصر 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>