سياسة تدفق وسائل الشرح

إثبات صحة مفتاح واجهة برمجة التطبيقات في التدفق المشترك

في هذا المثال، يتم استخدام مسار مشترَك لتنفيذ المهام الشائعة المتعلقة بالأمان. هنا يتحقّق التدفق المشترك من صحة مفتاح واجهة برمجة التطبيقات. يمكن للخوادم الوكيلة لواجهة برمجة التطبيقات والمسارات المشتركة الأخرى استخدام FlowCallout لإجراء اتصالات في هذا المسار المشترك.

يتضمّن تعريف المسار المشترَك التالي سياسة Verify-API-Key يتم تنفيذها. عند استدعاء التدفق المشترك من سياسة 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>

تطلب سياسة FlowCallout التالية، المستخدمة في الخادم الوكيل لواجهة برمجة التطبيقات، التدفق المشترك السابق إلى والتحقق من مفتاح واجهة برمجة التطبيقات. حزمة التدفق المشتركة لـ 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. تطلب سياسة 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 المشترك التالي سياسة 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. يسترد هذا النص البرمجي القيم من المتغيرات التي تم إنشاؤها من عناصر سياسة 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 إلى المسار المشترَك ثم إلى سياسة 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>

مثال

تعمل سياسة 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="outputVariable">string.handler.output</Parameter>
  </Parameters>
  <SharedFlowBundle>StringHandler</SharedFlowBundle>
</FlowCallout>

البنية

<Parameters>
  <Parameter name="parameter-name" value='parameter-value' />
</Parameters>