إرفاق السياسات وإعدادها في واجهة المستخدم

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

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

  1. ضبط مثيل من نوع السياسة
  2. أرفِق مثيل السياسة بتدفق.

يوضِّح المخطّط أدناه العلاقة بين السياسات والمسارات. كما يظهر لك، يتم إرفاق السياسة بـ "مسار البيانات" على أنّها "خطوة للمعالجة". لضبط السلوك المطلوب لواجهة برمجة التطبيقات، يجب معرفة بعض المعلومات عن التدفقات. (تمت تغطية هذا الموضوع سابقًا في قسم ضبط المسارات.)

العلاقة بين السياسات وعمليات التدفق

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

إرفاق سياسة بالتدفق

لإرفاق سياسة بتدفق:

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

    • الاسم: اسم فريد للسياسة يتطابق اسم السياسة مع الاسم المعروض، مع الاستثناءات التالية:

      • يتم استبدال المسافات بشرطات.

      • يتم استبدال الشرطات المتتالية بشرطة واحدة.

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

  6. انقر على إضافة.

    يتم إرفاق السياسة بالمسار المحدّد.

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

السياسات في PreFlow في طريقة العرض Design and Code

إضافة سياسة بدون إرفاقها بتدفق

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

انقر على + لإضافة سياسة.

يتم وضع علامة "مفصل" على السياسة غير المرتبطة بأي مسار في قائمة السياسات، كما هو موضّح بجوار سياسة الرسالة الرئيسية لواجهة برمجة التطبيقات الموضّحة في الشكل السابق.

بعد إنشاء السياسة، يمكنك إرفاقها بالتدفق عن طريق سحبها وإفلاتها من قائمة السياسات في التدفق المطلوب في طريقة عرض المصمم.

فصل السياسات عن التدفق

لفصل سياسة عن أحد التدفقات، اختَر التدفق. مرِّر مؤشر الماوس فوق رمز السياسة في عرض المصمم للتدفق. انقر على X في الدائرة التي تظهر في الرمز.

حذف مثيل سياسة

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

ضبط السياسات في واجهة المستخدم

عندما تنشئ واجهة المستخدم مثيل سياسة، تطبِّق قيمًا تلقائية معقولة للإعدادات الشائعة. وقد تحتاج إلى تعديل هذه الإعدادات لاستيفاء المتطلبات.

مثلاً:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<SpikeArrest async="false" continueOnError="false" enabled="true" name="spikearrest-1">
  <DisplayName>SpikeArrest-1</DisplayName>
  <FaultRules/>
  <Properties/>
  <Identifier ref="request.header.some-header-name"/>
  <MessageWeight ref="request.header.weight"/>
  <Rate>30ps</Rate>
</SpikeArrest>

يمكنك إعداد سياسة من خلال تعديل إعدادات XML الخاصة بها مباشرةً في طريقة عرض الرمز. على سبيل المثال، يتم مبدئيًا ضبط أعلى معدّل للرسائل في سياسة "منع الارتفاع على 30 رسالة" على 30 رسالة في الثانية. يمكنك تغيير الحدّ الأقصى لمعدّل الزحف من خلال تغيير قيمة العنصر <Rate> في ملف XML الخاص بالسياسة. لمزيد من التفاصيل حول ضبط السياسات، يمكنك الاطّلاع على مرجع السياسات.

يمكنك أيضًا قص السياسات ولصقها في طريقة عرض Code. وهذه طريقة رائعة لإعادة استخدام سياسات من النماذج المتوفرة على GitHub.

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

للحصول على مستندات خاصة بسياسة الحصص المستخدمة في هذا الموضوع، يُرجى الاطّلاع على سياسة الحصة.