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

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

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

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

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

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

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

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

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

  • الأمان، من خلال رمز التفويض باستخدام بروتوكول 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 يحتوي على عناصر مصدر التدفق المشترك (راجع استيراد خادم وكيل لواجهة برمجة تطبيقات جديد للحصول على مزيد من المعلومات عن استيراد الخوادم الوكيلة). في ما يلي كيفية استيراد عملية مشترَكة باستخدام 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. نشر المسار المشترَك في البيئة قبل نشر الخوادم الوكيلة أو المسارات المشترَكة التي ستستهلكها يمكنك نشر مسار مشترَك بالطريقة نفسها التي تنشر بها خادم وكيل لواجهة برمجة التطبيقات. (لمزيد من المعلومات، يمكنك الاطّلاع على نظرة عامة على النشر).

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

    يمكنك نشر مسار مشاركة باستخدام طلب بيانات من Management API، مثل ما يلي:

    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 للاطّلاع على مزيد من المعلومات). في ما يلي نموذج الطلب باستخدام 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 لإنشاء مسار مشترَك، يمكنك إنشاء مسار من scratch أو من خلال استيراد مصادر مسارات حالية كملف zip .لربط المسارات.

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

    Edge

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

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

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

    3. اختَر التطوير > التدفقات المشتركة في شريط التنقل الأيمن.

    Classic 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 الجديدة إلى الخادم الوكيل الذي تريد إجراء الاتصال به.

انظر أيضًا

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