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

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

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

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

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

يوضّح الفيديو التالي الذي تبلغ مدته 5 دقائق كيفية إنشاء مسار مشترك وتتبُّعه في واجهة مستخدم Classic 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.

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

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

    Edge

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

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

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

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

    Classic Edge (Private Cloud)

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

انظر أيضًا

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