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

تأكيد مفتاح واجهة برمجة التطبيقات في عملية المشاركة

في هذا المثال، يتم استخدام تدفق مشترك لتنفيذ مهام شائعة متعلقة بالأمان. في ما يلي، يتحقّق التدفق المشترك من صحة مفتاح واجهة برمجة التطبيقات. يمكن أن تستخدم خوادم وكيل واجهة برمجة التطبيقات وتدفقات مشتركة أخرى سياسة 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. 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. في التدفق المشترك، تحدّد SharedStringFunctions سياسة JavaScript التالية ملف 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 في خادم وكيل واجهة برمجة التطبيقات الأصلية.

البنية

يمكنك استخدام هذا العنصر مع أي من أشكال الصيغة التالية. يُرجى العِلم أنّه عند استخدام قيمة حرفية، سيعتمد تنسيق القيمة التي تحدّدها على الرمز الذي يستخدمها.

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