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

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

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

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

في ما يلي أكثر الطرق شيوعًا لتعديل إعدادات الخادم الوكيل:

• استخدام محرّر XML في واجهة مستخدم Edge
• تنزيل التهيئة وتعديلها محليًا، كما هو موضح في الدليل المحلي تطوير عمليات ضبط الخادم الوكيل

التطوير المحلي لإعدادات الخادم الوكيل

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

يصف هذا القسم كيفية استخدام واجهة المستخدم لتنزيل تهيئة حالية للخادم الوكيل، وتعديلها، ثم تحميله مرة أخرى إلى Edge ليتم نشره. يمكنك أيضًا استخدام أداة واجهة برمجة التطبيقات API لتنزيل إعداد خادم وكيل جديد ونشره (باستخدام fetchproxy deployproxy أوامر، على التوالي.)

لتعديل إعدادات خادم وكيل محليًا باستخدام واجهة المستخدم:

1. نزِّل الإعدادات الحالية للخادم الوكيل في واجهة مستخدم Edge. (في الخوادم الوكيلة لواجهة برمجة التطبيقات عرض، اختر المشروع > تنزيل النسخة السابقة).
2. على جهازك المحلي، أنشئ دليلاً جديدًا ووسِّع ملف ZIP الذي تم تنزيله إلى بها.

   لتوسيع ملف ZIP، يمكنك استخدام أداة مساعدة مثل unzip، كما يلي مثال يوضح:

   mkdir myappdir
   unzip ./my-app_app_rev3_2019_04_20.zip -d myappdir

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

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

   على سبيل المثال، لتفعيل مراقبة الصحة في الخادم الوكيل لواجهة برمجة التطبيقات، يمكنك تعديل ملف إعداد TargetEndpoint في دليل /apiproxy/targets/. الملف الافتراضي في هذا الدليل هو default.xml، ولكن قد تكون هناك ملفات بأسماء مختلفة في حال استخدامك الأهداف المشروطة.

   في هذه الحالة، إذا لم يكن ملف إعداد TargetEndpoint ودليله موجودين، وإنشائها.

4. بعد الانتهاء من تعديل ملفات إعداد الخادم الوكيل، تأكَّد من حفظ التغييرات.
5. إلى الدليل الجديد الذي أنشأته عند توسيع ملفات ZIP (جذر ملفات الإعداد الموسّعة).

   على سبيل المثال، في حال توسيع الملفات في دليل /myappdir، يمكنك التغيير إلى هذا الدليل، كما يبيِّن المثال التالي:

   cd myappdir

   يجب الانتقال إلى هذا الدليل قبل إعادة أرشفة ملفات إعداد الخادم الوكيل. لأنك لا تريد تضمين الدليل /myappdir في ملف ZIP. يجب أن يكون دليل المستوى الأعلى في ملف ZIP هو /apiproxy.

6. عليك إعادة أرشفة ملفات إعداد الخادم الوكيل، بما في ذلك الملفات الجديدة أو التي تم تغييرها. يمكنك استخدام مثل zip، كما يبيِّن المثال التالي:

   zip my-new-proxy.zip -r .

   يجب أن يكون دليل المستوى الأعلى في ملف ZIP هو /apiproxy.

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

   تزيد Edge من رقم النسخة السابقة لإعدادات الخادم الوكيل الجديدة نيابةً عنك عند التحميل. بها.

7. حمِّل إعدادات الخادم الوكيل الجديدة باستخدام واجهة مستخدم Edge. (في الخوادم الوكيلة لواجهة برمجة التطبيقات عرض، اختر المشروع > تحميل نسخة جديدة).

   إذا ظهرت لك رسالة خطأ مثل Bundle is invalid. Empty bundle.، تأكَّد من دليل المستوى الأعلى لملف ZIP هو /apiproxy. إذا لم يكن الأمر كذلك، فأعد أرشفة ملفات إعداد الخادم الوكيل من جذر الدليل الموسّع.

   بعد تحميل إعدادات الخادم الوكيل الجديدة، تزيد Edge من رقم المراجعة يعرضه في طريقة عرض ملخص النُسخ السابقة.

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

8. انشر مراجعتك الجديدة.

لمزيد من المعلومات، يُرجى مراجعة دليل تعليمي: كيفية تنزيل خادم وكيل باستخدام واجهة المستخدم وواجهة برمجة تطبيقات الإدارة في منتدى Apigee:

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

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

بنية دليل خادم وكيل واجهة برمجة التطبيقات والمحتوى

يتم تحديد المكوّنات في الجدول أعلاه من خلال ملفات الإعداد في ما يلي: بنية الدليل:

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

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

• الإعداد الأساسي
• ProxyEndpoint
• TargetEndpoint
  • إعداد نقطة النهاية المستهدفة لطبقة النقل الآمنة/طبقة المقابس الآمنة
• السياسات
• زهور
• المراجع

الإعداد الأساسي

/apiproxy/weatherapi.xml

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

نموذج الضبط:

<APIProxy name="weatherapi">
</APIProxy>

عناصر الإعداد الأساسية

ProxyEndpoint

توضح الصورة التالية مسار الطلب/الاستجابة:

/apiproxy/proxies/default.xml

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

سيتم تخزين النموذج التالي لإعداد ProxyEndpoint ضمن /apiproxy/proxies:

<ProxyEndpoint name="default">
  <PreFlow/>
  <Flows/>
  <PostFlow/>
  <HTTPProxyConnection>
    <BasePath>/weather</BasePath>
    <VirtualHost>default</VirtualHost>
  </HTTPProxyConnection>
  <FaultRules/>
  <DefaultFaultRule/>
  <RouteRule name="default">
    <TargetEndpoint>default</TargetEndpoint>
  </RouteRule>
</ProxyEndpoint>

عناصر الضبط المطلوبة في ProxyEndpoint الأساسية هي:

إعداد نقطة نهاية الخادم الوكيل العناصر

كيفية ضبط RouteRules

يشير عنصر TargetEndpoint يُسمى إلى ملف إعداد ضمن /apiproxy/targets إلى الذي يعيد RouteRule توجيه الطلب بعد معالجته بواسطة ProxyEndpoint.

على سبيل المثال، تشير RouteRule التالية إلى الإعدادات /apiproxy/targets/myTarget.xml:

<RouteRule name="default">
  <TargetEndpoint>myTarget</TargetEndpoint>
</RouteRule>

استدعاء عنوان URL المباشر

يمكن أيضًا لـ ProxyEndpoint استدعاء خدمة خلفية مباشرةً. يتجاوز الاستدعاء المباشر لعنوان URL أي تسمى إعداد TargetEndpoints ضمن /apiproxy/targets). لهذا السبب، TargetEndpoint هو إعداد اختياري للخادم الوكيل لواجهة برمجة التطبيقات، مع أنّه في الواقع استدعاء مباشر من ProxyEndpoint

على سبيل المثال، تقوم RouteRule التالي باستدعاء HTTP إلى http://api.mycompany.com/v2

<RouteRule name="default">
  <URL>http://api.mycompany.com/v2</URL> 
</RouteRule>

المسارات الشرطية

يمكن ربط سلسلة RouteRules لدعم التوجيه الديناميكي في وقت التشغيل. يمكن أن تكون الطلبات الواردة يتم توجيهها إلى إعدادات TargetEndpoint مباشرةً أو إلى مزيج من الاثنين التي تستند إلى رؤوس HTTP أو محتوى الرسالة أو معلمات طلب البحث أو المعلومات السياقية مثل وقت واليوم واللغة وما إلى ذلك

تعمل RouteRules الشرطية مثل العبارات الشرطية الأخرى على Apigee Edge. راجِع مرجع الشروط ومرجع المتغيّرات.

على سبيل المثال، تقيّم مجموعة RouteRule التالية أولاً الطلب الوارد للتحقُّق قيمة عنوان HTTP. في حال كان عنوان HTTP routeTo يتضمّن القيمة TargetEndpoint1، تتم إعادة توجيه الطلب إلى TargetEndpoint المسماة. TargetEndpoint1 إذا لم يكن الأمر كذلك، ستتم إعادة توجيه الطلب الوارد إلى http://api.mycompany.com/v2

<RouteRule name="MyRoute">
  <Condition>request.header.routeTo = "TargetEndpoint1"</Condition>
  <TargetEndpoint>TargetEndpoint1</TargetEndpoint>
</RouteRule>
<RouteRule name="default">
  <URL>http://api.mycompany.com/v2</URL>
</RouteRule>

مسارات فارغة

يمكن تحديد RouteRule الفارغة لدعم السيناريوهات التي لا تتوفّر فيها رسالة الطلب. يجب إعادة توجيهها إلى TargetEndpoint. ويفيد ذلك عندما ينفذ ProxyEndpoint جميع المعالجة اللازمة، على سبيل المثال باستخدام JavaScript لاستدعاء خدمة خارجية أو واسترداد البيانات من بحث إلى خدمات واجهة برمجة التطبيقات" مخزن المفتاح/القيمة.

على سبيل المثال، يحدد ما يلي مسارًا فارغًا:

<RouteRule name="GoNowhere"/>

يمكن أن تكون المسارات الفارغة الشرطية مفيدة. في المثال التالي، يتم ضبط مسار فارغ على التنفيذ عندما يتضمّن عنوان HTTP request.header.X-DoNothing قيمة أخرى غير null

<RouteRule name="DoNothingOnDemand">
  <Condition>request.header.X-DoNothing != null</Condition>
</RouteRule>

تذكَّر أنّه يمكن وضع تسلسل RouteRules، وبالتالي يكون المسار الفارغ المشروط عادةً واحدًا. مكون من مجموعة من قواعد RouteRules وهي مُصمَّمة لدعم التوجيه المشروط.

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

<RouteRule name="DoNothingUnlessTheCacheIsStale">
  <Condition>lookupcache.LookupCache-1.cachehit is true</Condition>
</RouteRule>

TargetEndpoint

أما TargetEndpoint، فهو مكافئ صادر لـ ProxyEndpoint. تعمل TargetEndpoint إلى خدمة خلفية أو واجهة برمجة تطبيقات -- حيث يرسل الطلبات ويتلقى الاستجابات.

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

إعدادات TargetEndpoint

/targets/default.xml

تحدد TargetEndpoint الاتصال الصادر من Apigee Edge إلى خدمة أخرى أو المصدر.

وفي ما يلي نموذج لضبط نقطة النهاية المستهدفة:

<TargetEndpoint name="default">
  <PreFlow/>
  <Flows/>
  <PostFlow/>
  <HTTPTargetConnection>
    <URL>http://mocktarget.apigee.net</URL>
    <SSLInfo/>
  </HTTPTargetConnection>
  <FaultRules/>
  <DefaultFaultRule/>
  <ScriptTarget/>
  <LocalTargetConnection/>
</TargetEndpoint>

إعدادات TargetEndpoint العناصر

ويمكن لنقطة النهاية المستهدفة استدعاء أي هدف بإحدى الطرق التالية:

• HTTPTargetConnection لطلبات HTTP(S)
• LocalTargetConnection لسلسلة محلية من خادم وكيل إلى خادم.
• ScriptTarget لاستدعاءات المكالمات إلى شبكة Edge مستضافة نص Node.js البرمجي

يجب إعداد حقل واحد فقط من هذه العناصر في TargetEndpoint.

إعداد نقطة النهاية المستهدفة لطبقة النقل الآمنة/طبقة المقابس الآمنة

غالبًا ما تحتاج نقاط النهاية المستهدفة إلى إدارة اتصالات HTTPS باستخدام خلفية غير متجانسة. البنية الأساسية. لهذا السبب، يتم دعم عدد من إعدادات تهيئة TLS/SSL.

TLS/SSL عناصر ضبط نقطة النهاية المستهدفة

<Ciphers>
 <Cipher>TLS_RSA_WITH_3DES_EDE_CBC_SHA</Cipher>    
 <Cipher>TLS_RSA_WITH_DES_CBC_SHA</Cipher>
</Ciphers>

<Protocols>
 <Protocol>TLSv1.1</Protocol>
 <Protocol>TLSv1.2</Protocol>
</Protocols>

<CommonName wildcardMatch="true">*.myhost.com</CommonName>

نموذج TargetEndpoint مع تفعيل مصادقة العميل الصادر

<TargetEndpoint name="default">
  <HttpTargetConnection>
        <URL>https://myservice.com</URL>
    <SSLInfo>
      <Enabled>true</Enabled>
      <ClientAuthEnabled>true</ClientAuthEnabled>
      <KeyStore>myKeystore</KeyStore>
      <KeyAlias>myKey</KeyAlias>
      <TrustStore>myTruststore</TrustStore>
    </SSLInfo>
  </HttpTargetConnection>
</TargetEndpoint>

للحصول على تعليمات تفصيلية، يُرجى الاطّلاع على ضبط بروتوكول أمان طبقة النقل (TLS). من Edge إلى الخلفية (السحابة الإلكترونية والسحابة الإلكترونية الخاصة).

استخدام متغيرات التدفق لضبط قيم TLS/SSL ديناميكيًا

يمكنك أيضًا ضبط تفاصيل بروتوكول أمان طبقة النقل (TLS)/طبقة المقابس الآمنة بشكل ديناميكي لتلبية متطلبات بيئة التشغيل المرنة. على سبيل المثال، إذا كان الخادم الوكيل يتصل باثنين من الأهداف المحتملة المختلفتين (هدف اختباري يمكنك جعل خادم وكيل واجهة برمجة التطبيقات يكتشف البيئة التي الاتصال وضبط المراجع ديناميكيًا على ملف تخزين المفاتيح والثقة المناسبَين. ما يلي: تشرح مقالة منتدى Apigee هذا السيناريو بمزيد من التفاصيل وتوفّر واجهة برمجة تطبيقات قابلة للنشر. أمثلة على الخادم الوكيل: https://community.apigee.com/articles/21424/dynamic-sslinfo-for-targetendpoint-using-variable.html.

في المثال التالي، طريقة ضبط العلامة <SSLInfo> في ضبط TargetEndpoint، يمكن تقديم القيم في وقت التشغيل، على سبيل المثال، باستخدام Java وسيلة شرح أو سياسة JavaScript أو سياسة "تعيين رسالة" استخدام أي متغيرات للرسالة سيحتوي على القيم التي تريد تعيينها.

يُسمح باستخدام المتغيرات في العناصر التالية فقط.

<SSLInfo>
    <Enabled>{myvars.ssl.enabled}</Enabled>
    <ClientAuthEnabled>{myvars.ssl.client.auth.enabled}</ClientAuthEnabled>
    <KeyStore>{myvars.ssl.keystore}</KeyStore>
    <KeyAlias>{myvars.ssl.keyAlias}</KeyAlias>
    <TrustStore>{myvars.ssl.trustStore}</TrustStore>
</SSLInfo>

استخدام مراجع لضبط قيم بروتوكول أمان طبقة النقل (TLS) وطبقة المقابس الآمنة (SSL) ديناميكيًا

عند ضبط نقطة نهاية مستهدفة تستخدم بروتوكول HTTPS، يجب مراعاة الحالة عندما تنتهي صلاحية شهادة TLS/SSL، أو يتطلب منك تغيير إعداد النظام تحديث الشهادة. ضِمن تثبيت Edge for Private Cloud عند ضبط بروتوكول أمان طبقة النقل (TLS) أو طبقة المقابس الآمنة (SSL) باستخدام قيم ثابتة أو من خلال باستخدام متغيرات التدفق، قد تضطر إلى إعادة تشغيل معالِجات الرسائل.

لمزيد من المعلومات، يُرجى الاطِّلاع على تحديث بروتوكول أمان طبقة النقل (TLS) الشهادة.

ومع ذلك، يمكنك اختياريًا ضبط TargetEndpoint لاستخدام مرجع في ملف تخزين المفاتيح أو ملف تخزين الثقة بدلاً من ذلك. تتمثل ميزة استخدام المرجع في إمكانية تحديث الرجوع إلى ملف تخزين مفاتيح مختلف أو مخزن ثقة لتحديث شهادة بروتوكول أمان طبقة النقل (TLS)/طبقة المقابس الآمنة بدون الاضطرار إلى إعادة تشغيل معالجات الرسائل.

على سبيل المثال، في ما يلي نقطة نهاية مستهدفة تستخدم مرجعًا لملف تخزين المفاتيح:

<SSLInfo> 
    <Enabled>true</Enabled> 
    <ClientAuthEnabled>false</ClientAuthEnabled> 
    <KeyStore>ref://keystoreref</KeyStore> 
    <KeyAlias>myKeyAlias</KeyAlias> 
</SSLInfo>

استخدِم طلب POST التالي من واجهة برمجة التطبيقات لإنشاء المرجع المُسمّى keystoreref:

curl -X POST  -H "Content-Type:application/xml" https://api.enterprise.apigee.com/v1/o/{org_name}/e/{env_name}/references \
-d '<ResourceReference name="keystoreref">
    <Refers>myTestKeystore</Refers>
    <ResourceType>KeyStore</ResourceType>
</ResourceReference>' -u email:password

يحدد المرجع اسم ملف تخزين المفاتيح ونوعه.

يمكنك استخدام طلب GET API التالي لعرض المرجع:

curl -X GET https://api.enterprise.apigee.com/v1/o/[org_name}/e/{env_name}/references/keystoreref -u uname:password

لتغيير المرجع لاحقًا إلى ملف تخزين مفاتيح مختلف، فإن التأكد من أن الاسم المستعار نفس الاسم، استخدم استدعاء PUT التالي:

curl -X PUT -H "Content-Type:application/xml" https://api.enterprise.apigee.com/v1/o/{org_name}/e/{env_name}/references/keystoreref \
-d '<ResourceReference name="keystoreref">
    <Refers>myNewKeystore</Refers>
    <ResourceType>KeyStore</ResourceType>
</ResourceReference>' -u email:password

TargetEndpoint من خلال موازنة الحمل المستهدَف

تتيح TargetEndpoints موازنة التحميل على مستوى عدة خوادم TargetServers مُسمّاة باستخدام ثلاث منصات تحميل. خوارزميات تحقيق التوازن.

للحصول على تعليمات تفصيلية، يُرجى الاطّلاع على مقالة موازنة التحميل في الخلفية. الخوادم.

السياسات

يتضمّن الدليل /policies في الخادم الوكيل لواجهة برمجة التطبيقات جميع السياسات المتاحة المرفق بالتدفقات في الخادم الوكيل لواجهة برمجة التطبيقات.

عناصر ضبط السياسة

مرفق السياسة

توضِّح الصورة التالية تسلسل تنفيذ مسارات الخادم الوكيل لواجهة برمجة التطبيقات:

كما هو موضح أعلاه:

يتم إرفاق السياسات كخطوات لمعالجة التدفقات. يُستخدم اسم السياسة للأغراض التالية: الإشارة إلى السياسة التي سيتم فرضها كخطوة معالجة تنسيق مرفق السياسة هو ما يلي:

<Step><Name>MyPolicy</Name></Step>

يتم فرض السياسات بالترتيب الذي يتم إرفاقها به بالتدفق. على سبيل المثال:

<Step><Name>FirstPolicy</Name></Step>
<Step><Name>SecondPolicy</Name></Step>

إعداد مرفقات السياسة العناصر

التدفقات

تحدد ProxyEndpoint وTargetEndpoint مسارًا لرسالة الطلب والردّ. قيد المعالجة. يتكون مسار المعالجة من تدفق الطلب وتدفق الاستجابة. كل طلب يتم تقسيم تدفق الاستجابة والاستجابة فرعيًا إلى PreFlow، وهو نوع اختياري أو أكثر من "شرطي" أو "مُسمّى" وPostFlow.

• PreFlow: يتم تنفيذه دائمًا. يتم التنفيذ قبل أي تدفقات شرطية.
• PostFlow: يتم تنفيذه دائمًا. يتم التنفيذ بعد أي تدفقات شرطية.

بالإضافة إلى ذلك، يمكنك إضافة PostClientFlow إلى ProxyEndpoint، والذي يتم تنفيذه بعد يتم إرجاع الرد إلى تطبيق العميل الذي أرسل الطلب. لا تسري إلا سياسة تسجيل الرسائل يمكن إرفاق إضافة تسجيل الدخول إلى Google Stackdriver. على هذا التدفق. تقلل PostClientFlow من وقت استجابة الخادم الوكيل لواجهة برمجة التطبيقات ويوفر معلومات تسجيل لا يتم احتسابه إلا بعد أن يتم إرجاع الرد إلى العميل، مثل client.sent.start.timestamp وclient.sent.end.timestamp. يتم استخدام المسار. ويهدف هذا الإجراء في المقام الأول إلى قياس الفاصل الزمني بين الطوابع الزمنية لبداية الردّ وانتهائه. .

مشاهدة فيديو إرشادي سريع

في ما يلي مثال على PostClientFlow مع إرفاق سياسة تسجيل الرسائل.

    ...
    <PostFlow name="PostFlow">
        <Request/>
        <Response/>
    </PostFlow>
    <PostClientFlow>
        <Request/>
        <Response>
            <Step>
                <Name>Message-Logging-1</Name>
            </Step>
        </Response>
    </PostClientFlow>
    ...

ينفِّذ مسار معالجة الخادم الوكيل لواجهة برمجة التطبيقات التدفقات بالتسلسل التالي:

مسار الطلب:

1. تدفق مسبق لطلب الخادم الوكيل
2. مسارات شرطية لطلب الخادم الوكيل (اختياري)
3. طلب الخادم الوكيل PostFlow
4. التدفق المسبق للطلبات المستهدفة
5. مسارات شرطية للطلب المستهدف (اختياري)
6. الطلب المستهدَف PostFlow

مسار الاستجابة:

1. التدفق المسبق للاستجابة المستهدفة
2. التدفقات الشرطية للاستجابة المستهدفة (اختياري)
3. الردّ المستهدَف PostFlow
4. تدفق استجابة الخادم الوكيل
5. التدفقات الشرطية لاستجابة الخادم الوكيل (اختياري)
6. PostFlow لاستجابة الخادم الوكيل
7. رد PostClientFlow (اختياري)

يجب ضبط عمليات التدفق التي تتضمن مرفقات سياسة فقط في ProxyEndpoint أو إعدادات TargetEndpoint يجب تحديد PreFlow وPostFlow فقط في نقطة نهاية ProxyEndpoint أو ضبط TargetEndpoint عند الحاجة إلى فرض سياسة أثناء PreFlow أو PostFlow قيد المعالجة.

على عكس التدفقات الشرطية، لا يكون ترتيب عناصر PreFlow وPostFlow مهم للغاية--سينفذ الخادم الوكيل لواجهة برمجة التطبيقات دائمًا كل منها عند النقطة المناسبة في مسار العملية، بغض النظر عن مكان ظهورها في إعدادات نقطة النهاية.

التدفقات الشرطية

تدعم نقاط النهاية ProxyEndpoints وTargetEndpoints عددًا غير محدود من التدفقات الشرطية (أيضًا تُعرف باسم "التدفقات المُعنونة").

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

من خلال تحديد التدفقات الشرطية، يمكنك تطبيق خطوات المعالجة في خادم وكيل لواجهة برمجة التطبيقات. بناءً على:

• عنوان URI للطلب
• فعل HTTP (GET/PUT/POST/DELETE)
• قيمة معلَمة طلب البحث والعنوان ومعلَمة النموذج
• العديد من أنواع الحالات الأخرى

على سبيل المثال، يحدد التدفق الشرطي التالي أنه يتم تنفيذه فقط عندما مسار مورد الطلب هو /accesstoken. ينبغي أن يتضمن أي طلب وارد المسار /accesstoken إلى تنفيذ هذا المسار، بالإضافة إلى أي سياسات المرتبطة بالتدفق. في حال لم يتضمّن مسار الطلب اللاحقة /accesstoken، لن يتم تنفيذ التدفق (على الرغم من وجود تدفق شرطي آخر ربما).

<Flows>
  <Flow name="TokenEndpoint">
    <Condition>proxy.pathsuffix MatchesPath "/accesstoken"</Condition>
    <Request>
      <Step>
        <Name>GenerateAccessToken</Name>
      </Step>
    </Request> 
  </Flow>
</Flows>   

عناصر إعداد التدفق

جارٍ معالجة الخطوات

تفرض Apigee Edge الترتيب التسلسلي للتدفق المشروط. التدفقات الشرطية التنفيذ من أعلى إلى أسفل. التدفق المشروط الأول الذي يتم تقييم حالته يتم تنفيذ true ويتم تنفيذ تدفق مشروط واحد فقط.

في إعدادات التدفق التالية مثلاً، أي طلب وارد لا يتضمن تؤدّي لاحقة المسار /first أو /second إلى ThirdFlow التنفيذ، ما يؤدي إلى فرض السياسة المسماة Return404.

<Flows>
  <Flow name="FirstFlow">
    <Condition>proxy.pathsuffix MatchesPath "/first"</Condition>
    <Request>
      <Step><Name>FirstPolicy</Name></Step>
    </Request>
  </Flow>
  <Flow name="SecondFlow">
    <Condition>proxy.pathsuffix MatchesPath "/second"</Condition>
    <Request>
      <Step><Name>FirstPolicy</Name></Step>
      <Step><Name>SecondPolicy</Name></Step>
    </Request>
  </Flow>
  <Flow name="ThirdFlow">
    <Request>
      <Step><Name>Return404</Name></Step>
    </Request>
  </Flow>
</Flows>

المراجع

"الموارد" (ملفات الموارد للاستخدام في الخوادم الوكيلة لواجهة برمجة التطبيقات) هي النصوص البرمجية والرموز وعمليات تحويل XSL التي يمكن إرفاقها بالتدفقات باستخدام السياسات. تظهر هذه في "النصوص البرمجية" قسم من واجهة برمجة التطبيقات الخادم الوكيل في واجهة مستخدم الإدارة.

راجِع ملفات الموارد للاطّلاع على الملفات المتوافقة. والموارد.

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

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