مسارات مشتركة قابلة لإعادة الاستخدام

يتم الآن عرض مستندات Apigee Edge.
انتقِل إلى مستندات Apigee X.
المعلومات

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

من خلال تجميع الوظائف المفيدة في أماكن متعدّدة في مكان واحد، يساعدك التدفق المشترك في ضمان الاتّساق، وتقصير وقت التطوير، وإدارة الرموز البرمجية بسهولة أكبر.

يوضح الفيديو التالي كيفية إنشاء وتتبع تدفق مشترك في واجهة مستخدم Edge.

يوضّح الفيديو التالي الذي تبلغ مدته 5 دقائق كيفية إنشاء مسار مشترَك وتتبُّعه في واجهة مستخدم الإصدار الكلاسيكي من Edge (استخدام Edge في السحابة الإلكترونية الخاصة فقط).

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

ولمزيد من المعلومات عن سياسة تدفق وسائل الشرح، يُرجى الاطّلاع على سياسة تدفق وسائل الشرح. لمزيد من المعلومات عن خطّافات التدفق، يُرجى الاطّلاع على إرفاق مسار مشترَك باستخدام خطّاف تدفق.

على سبيل المثال، لنفترض أنّ لديك مجالات وظائف تُستخدم في أماكن متعدّدة أو يجب توحيدها على مستوى واجهات برمجة التطبيقات في مؤسستك. يمكن أن يكون لديك مسار مشترك لكل فئة، بما في ذلك:

  • security، مع رمز التفويض باستخدام OAuth والتحقّق من مفتاح واجهة برمجة التطبيقات، بالإضافة إلى رمز الحماية من التهديدات.
  • تسجيل الدخول، لإنشاء رسائل خطأ عادية.
  • التوسّط للتحويل بين تنسيقَي الرسائل XML وJSON.

في الرسم التوضيحي التالي، يطلب خادمان وكيلان لواجهة برمجة التطبيقات (باستخدام سياسة FlowCallout) تدفقًا مشتركًا لمصادقة طلبات المستخدمين الواردة. تم نشر AuthSharedFlow بشكل منفصل على المؤسسة قبل الخوادم الوكيلة لكي يكون متاحًا لمعالجة الطلبات الواردة من الخوادم الوكيلة. يمكن تطوير تدفق مشترك وإدارته من قِبل فريق مسؤول عن سياسات الشركة الواسعة النطاق، ثم استهلاكه في الخوادم الوكيلة من قِبل الفِرق التي تعمل على إنشاء تطبيقات أكثر تخصصًا.

تطوير تدفق مشترك

عند تطوير تدفق مشترك، يجب عليك دائمًا اختباره مع الاستدعاءات التي يتم إرسالها إلى خادم وكيل لواجهة برمجة التطبيقات. بمعنى آخر، لا يمكنك إرسال الطلبات مباشرةً إلى مسار مشترَك كما تفعل مع خادم وكيل لواجهة برمجة التطبيقات. بدلاً من ذلك، يمكنك إرسال الطلبات إلى خادم وكيل لواجهة برمجة التطبيقات والذي بدوره يطلب المسار المشترك.

فيما يلي الخطوات عالية المستوى لتطوير تدفق مشترك:

  1. اكتشف ما يجب أن تكون عليه مجموعة الميزات المشتركة.

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

  2. طوّر مسارًا مشتركًا من خلال تطبيق سياسات وموارد داعمة، تمامًا كما تفعل عند تطوير خادم وكيل لواجهة برمجة التطبيقات.

    التدفق المشترك هو سلسلة من الخطوات الشرطية. ولذلك فإن تطوير خادم يشبه تطوير خادم وكيل لواجهة برمجة تطبيقات. يمكنك تضمين السياسات والمراجع التي قد تدرجها في خادم وكيل.

    على سبيل المثال، كجزء من فريق الدعم في إدارة عدد الزيارات، يمكنك تنفيذ سياسة "إيقاف أي ارتفاع في عدد الزيارات" للسماح بـ 30 طلبًا فقط في الثانية، كما في المثال التالي:

    <SpikeArrest async="false" continueOnError="false" enabled="true" name="Spike-Arrest">
        <DisplayName>Spike Arrest</DisplayName>
        <Properties/>
        <Identifier ref="request.header.some-header-name"/>
        <MessageWeight ref="request.header.weight"/>
        <Rate>30ps</Rate>
    </SpikeArrest>
    

    بعد ذلك، يمكنك إرفاق سياسة "إيقاف أي ارتفاع في عدد الزيارات" كخطوة مشتركة لإدارة الزيارات. سيتم تنفيذ السياسة لأي خادم وكيل لواجهة برمجة التطبيقات يستدعي التدفق المشترك.

    <SharedFlow name="default">
        <Step>
            <Name>Spike-Arrest</Name>
        </Step>
    </SharedFlow>
    

    للحصول على معلومات حول طريقة بدء تدفق مشترك في وحدة تحكُّم الإدارة، راجِع إنشاء تدفق مشترك في واجهة مستخدم Edge.

    كما هي الحال مع الخوادم الوكيلة لواجهة برمجة التطبيقات، يمكنك استيراد ملف ZIP يحتوي على عناصر مصدر التدفق المشترك (راجِع استيراد خادم وكيل جديد لواجهة برمجة التطبيقات لمعرفة مزيد من المعلومات حول استيراد الخوادم الوكيلة). يوضِّح ما يلي كيفية استيراد مسار مشترَك باستخدام واجهة برمجة التطبيقات للإدارة:

    curl -X POST -F "file=@/path/to/zip/file.zip" \ 'https://api.enterprise.apigee.com/v1/o/{org_name}/sharedflows?action=import&name=shared-flow-name' \
    -u email:password
    
  3. نشر التدفق المشترك في البيئة قبل نشر الخوادم الوكيلة أو التدفقات المشتركة التي ستستهلكه. يمكنك نشر تدفق مشترك بالطريقة نفسها التي تنشر بها الخادم الوكيل لواجهة برمجة التطبيقات. (لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة على النشر.)

    يجب أن يكون التدفق المشترك في المؤسسة نفسها وأن يتم نشره في البيئة نفسها مثل الخوادم الوكيلة لواجهة برمجة التطبيقات وغيرها من التدفقات المشتركة التي تستهلكه. يؤدي نشر التدفق المشترك قبل الخوادم الوكيلة إلى حل مشكلة اعتماد الخادم الوكيل على التدفق المشترَك في وقت النشر.

    يمكنك نشر مسار مشترك من خلال طلب بيانات من واجهة برمجة تطبيقات الإدارة كما يلي:

    curl -X POST --header "Content-Type: application/octet-stream" \
    https://api.enterprise.apigee.com/v1/o/{org_name}/e/{env_name}/sharedflows/{shared_flow_name}/revisions/{revision_number}/deployments \
    -u email:password
    

    يمكنك أيضًا استبدال تدفق مشترك تم نشره حاليًا بدون فترة توقف. (يشبه ذلك إلى حد كبير الخوادم الوكيلة لواجهة برمجة التطبيقات. راجِع نشر الخوادم الوكيلة لواجهة برمجة التطبيقات باستخدام واجهة برمجة التطبيقات للإدارة لمزيد من المعلومات). في ما يلي نموذج الطلب الذي يستخدم واجهة برمجة تطبيقات الإدارة:

    curl -X POST --header "Content-Type:application/x-www-form-urlencoded" \
    https://api.enterprise.apigee.com/v1/o/{org_name}/e/{env_name}/sharedflows/{shared_flow_name}/revisions/{revision_number}/deployments?"override=true" \
    -u email:password
    
  4. طوِّر الخادم الوكيل لواجهة برمجة التطبيقات المستخدَم حتى يتمكّن من استدعاء التدفق المشترك كجزء من التدفق الخاص به.

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

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

    في الرمز التالي، تستدعي سياسة FlowCallout مسار مشترك يُطلق عليه اسم traffic-management-shared.

    <FlowCallout async="false" continueOnError="false" enabled="true" name="Traffic-Management-Flow-Callout">
        <DisplayName>Traffic Management FlowCallout</DisplayName>
        <Properties/>
        <SharedFlowBundle>traffic-management-shared</SharedFlowBundle>
    </FlowCallout>
    

    لمزيد من المعلومات، راجِع طلب مسار مشترَك من خادم وكيل لواجهة برمجة التطبيقات أو مسار مشترَك.

  5. انشر الخادم الوكيل لواجهة برمجة التطبيقات لبدء استخدام التدفق المشترك. (لمزيد من المعلومات عن النشر بشكل عام، يُرجى الاطّلاع على فهم النشر.)
  6. يمكنك تطوير تطبيقك بشكل متكرر من خلال التتبُّع، تمامًا كما تفعل مع الخادم الوكيل لواجهة برمجة التطبيقات.

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

    إليك الخطوات التي يمكنك اتّباعها:

    1. تأكَّد من أن المسار المشترك والخادم الوكيل لواجهة برمجة التطبيقات الذي يطلبه باستخدام سياسة FlowCallout يقع في المؤسسة نفسها ويتم نشرهما في البيئة نفسها.
    2. في علامة التبويب التتبُّع للخادم الوكيل لواجهة برمجة التطبيقات، ابدأ تتبُّع الخادم الوكيل لواجهة برمجة التطبيقات.
    3. أرسِل طلبًا إلى نقطة نهاية للخادم الوكيل في الخادم الوكيل لواجهة برمجة التطبيقات. يجب أن يشتمل التدفق من نقطة النهاية على سياسة FlowCallout التي تشير إلى التدفق المشترك.
    4. في علامة التبويب التتبُّع، افحص التدفق من الخادم الوكيل لواجهة برمجة التطبيقات إلى التدفق المشترك.

      يُرجى العلم أنّه أثناء التتبّع، يتم تمثيل المسار المشترَك كمجموعة من الخطوات أو السياسات مضمَّنة في مربّع رمادي. يسبق الرموز التي تمثل سياسات FlowCallout التدفقات المشتركة. (لمزيد من المعلومات حول التتبُّع، يُرجى الاطّلاع على استخدام أداة التتبُّع.)

إنشاء تدفق مشترك في واجهة مستخدم Edge

عند استخدام واجهة مستخدم Apigee Edge لإنشاء تدفق مشترك، يمكنك إما إنشاء مسار من البداية أو من خلال استيراد مصادر التدفق الحالية كملف ZIP لحزمة تدفق.

  1. انتقِل إلى صفحة "التدفقات المشتركة"، كما هو موضّح أدناه. في صفحة "التدفقات المشتركة"، يمكنك عرض قائمة بالمسارات المشتركة في المؤسسة، وتعديل المسارات أو حذفها في القائمة.

    Edge

    للوصول إلى صفحة "التدفقات المشتركة" باستخدام واجهة مستخدم Edge:

    1. سجِّل الدخول إلى apigee.com/edge.
    2. اختَر المؤسسة التي تحتوي على التدفق المشترك. يُرجى الاطّلاع على التبديل بين مؤسّساتك.

      سيكون المسار المشترَك متاحًا لأي خوادم وكيلة لواجهة برمجة التطبيقات وعمليات تدفق مشتركة تم نشرها في بيئة من هذه المؤسسة. ولن يكون هذا التطبيق متاحًا من خارج هذه المؤسسة.

    3. حدّد تطوير > المسارات المشتركة في شريط التنقل الأيمن.

    كلاسيكي Edge (السحابة الإلكترونية الخاصة)

    للوصول إلى صفحة "التدفقات المشتركة" باستخدام واجهة مستخدم الإصدار الكلاسيكي من Edge:

    1. سجِّل الدخول إلى http://ms-ip:9000، حيث يشير ms-ip إلى عنوان IP أو اسم نظام أسماء النطاقات لعقدة خادم الإدارة.
    2. اختَر المؤسسة التي تحتوي على التدفق المشترك. يُرجى الاطّلاع على التبديل بين مؤسّساتك.

      سيكون المسار المشترَك متاحًا لأي خوادم وكيلة لواجهة برمجة التطبيقات وعمليات تدفق مشتركة تم نشرها في بيئة من هذه المؤسسة. ولن يكون هذا التطبيق متاحًا من خارج هذه المؤسسة.

    3. حدّد واجهات برمجة التطبيقات > المسارات المشتركة في شريط التنقل العلوي.
  2. انقر على الزر + مسار مشترك لبدء إضافة مسار مشترَك جديد.
  3. في صفحة إنشاء تدفق مشترك، اختَر الطريقة التي تريد بها إنشاء التدفق الجديد:
    • أنشِئ مسارًا جديدًا من البداية. ستتمكّن من ضبط السياسات والموارد كخطوات في العملية.
      1. اختَر فارغ تدفق مشترك.
      2. أدخِل قيمة الاسم. وسيكون هذا هو الاسم الذي تستخدمه الخوادم الوكيلة لواجهة برمجة التطبيقات والتدفقات المشتركة الأخرى للإشارة إلى هذا التدفق المشترك. ويجب أن يكون الاسم وصفيًا للمطوّرين الذين يطّلعون على المسار.
      3. أدخِل وصفًا لتوفير مزيد من المعلومات عن عملية التدفق.
      4. انقر على التالي.
      5. اختياريًا، حدد البيئات التي تريد نشر التدفق الجديد فيها.

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

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

    • يمكنك إنشاء مسار مشترك من مصادر حالية عن طريق تحميل حزمة تدفق.
      1. اختَر حزمة التدفق المشترك لتحديد ملف .zip يحتوي على العناصر التي تريدها في المسار الجديد.

        تحتوي حزمة التدفق المشترك على العناصر المصدر لتدفق مشترك. على سبيل المثال، إذا أردت تنزيل مسار مشترك من واجهة مستخدم Edge، سيكون لديك ملف zip .يتضمّن حزمة التدفق.

      2. انقر على التالي.
      3. انقر على اختيار ملف لتصفّح ملف .zip الذي يتضمّن مصادر التدفق المشترك التي تريد استيرادها.
      4. في المربع اسم التدفق المشترك، أدخِل اسمًا للمسار المستورَد. وسيكون هذا الاسم الذي تستخدمه الخوادم الوكيلة لواجهة برمجة التطبيقات والتدفقات المشتركة الأخرى للإشارة إلى هذا التدفق المشترك. يجب أن يكون الاسم واضحًا للمطوّرين الذين يستخدمون هذا المسار.
      5. انقر على التالي.
      6. انقر على إنشاء لإنشاء التدفق الجديد من المصادر التي تستوردها.

يتم استدعاء مسار مشترك من خادم وكيل لواجهة برمجة التطبيقات أو مسار مشترك.

يمكنك استدعاء مسار مشترك من خادم وكيل أو من مسار مشترك آخر باستخدام سياسةFlowCallout.

  1. في واجهة مستخدم Edge، حدِّد موقع الخادم الوكيل أو التدفق المشترك الذي تريد الاتصال منه بتدفق مشترك آخر.
  2. في المستكشف، بجوار السياسات، انقر على الزر +.
  3. في قائمة السياسات، ضمن الإضافة، انقر على FlowCallout.
  4. أدخِل الاسم المعروض والاسم المعروض (المعرّف الفريد)، ثم اختَر المسار المشترك الذي ستستدعيه هذه السياسة.
  5. انقر على إضافة.
  6. أضِف سياسة FlowCallout الجديدة إلى الخادم الوكيل الذي تريد إجراء المكالمة عليه.

يمكن أيضًا مراجعة

ربط الخوادم الوكيلة لواجهة برمجة التطبيقات معًا