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

أنت الآن بصدد الاطّلاع على مستندات Apigee Edge.
انتقِل إلى مستندات Apigee X. info

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

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

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

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

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

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

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

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

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

تطوير سير عمل مشترك

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

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

  1. تحديد المجموعة المشتركة من الميزات

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

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

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

    على سبيل المثال، كجزء من دعم إدارة عدد الزيارات، يمكنك تنفيذ سياسة Spike Arrest للسماح بـ 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>

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

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

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

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

    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

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

    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 إلى الخادم الوكيل أو المسار المشترك الذي سيستهلكه. مثل سياسة Service Callout التي تستخدمها للاتصال بخدمة أخرى، تتصل سياسة 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. سجِّل الدخول إلى واجهة مستخدم New Edge على http://host:3001/edge، حيث host هو عنوان IP أو اسم نظام أسماء النطاقات للمضيف الذي يشغّل واجهة مستخدم New Edge.
    2. اختَر المؤسسة التي تحتوي على سلسلة الإجراءات المشترَكة. يمكنك الاطّلاع على التبديل بين مؤسساتك.

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

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

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

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

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

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

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

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

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

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

انظر أيضًا

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