مشاركة عبر

كيفية إعداد نُهج Azure API Management أو تعديلها

  • مقالة

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

توضح لك هذه المقالة كيفية تكوين النهج في مثيل APIM عن طريق تحرير تعريفات النهج في مدخل Microsoft Azure. يعتبر كل تعريف نهج مستند XML يصف سلسلة من العبارات الواردة والصادرة التي يتم تشغيلها بشكل تسلسلي بناء على طلب واجهة برمجة التطبيقات والاستجابة لها.

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

مزيد من المعلومات عن النهج:

المتطلبات الأساسية

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

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

  1. في مدخل Microsoft Azure، ابحث عن خدمات APIM وحددها.

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

  2. في صفحة خدمات إدارة واجهة برمجة التطبيقات، حدد مثيل إدارة واجهة برمجة التطبيقات.

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

تكوين النهج في المدخل

يوضح المثال التالي كيفية تكوين نهج باستخدام خيارين في محرر النهج في المدخل:

  • محرر مستند إلى نموذج موجه لتبسيط تكوين العديد من النهج
  • محرر التعليمات البرمجية حيث يمكنك إضافة XML أو تحريره مباشرة

في هذا المثال، يقوم النهج بتصفية الطلبات من عناوين IP واردة معينة. يتم تحديد نطاقها إلى واجهة برمجة تطبيقات محددة.

إشعار

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

لتكوين نهج:

  1. في شريط التنقل الأيسر لمثيل API Management، حدد APIs.

  2. حدد واجهة برمجة تطبيقات قمت باستيرادها مسبقا.

  3. حدد علامة التبويب Design.

  4. لتطبيق النهج على جميع العمليات، حدد All operations.

  5. في القسم المعالجة الواردة، حدد + Add policy.

    أضف نهج في APIM

  6. في إضافة نهج وارد، حدد نهجاً لإضافته. على سبيل المثال، حدد تصفية عناوين IP.

    نهج تصفية عناوين IP

    تلميح

    • يتم تحديد نطاق النهج المعروضة في قسم النهج الذي تقوم بتكوينه - في هذه الحالة، للمعالجة الواردة.
    • إذا لم تتمكن من رؤية نهج تريده، فحدد لوحة النهج الأخرى. سيؤدي ذلك إلى فتح محرر التعليمات البرمجية XML وعرض قائمة كاملة من النهج لهذا القسم والنطاق.

  7. حدد Allowed IPs>+ Add IP filter وأضف عناوين IP الأولى والأخيرة لنطاق من العناوين الواردة المسموح لها بإجراء طلبات واجهة برمجة التطبيقات. إضافة نطاقات عناوين IP أخرى، إذا لزم الأمر.

    تكوين عناوين IP المتاحة

  8. حدد Save لنشر التغييرات إلى بوابة APIM على الفور.

    يظهر نهج ip-filter الآن في قسم المعالجة الواردة.

تكوين النُهج في نطاقات مختلفة

تمنحك APIM المرونة لتكوين تعريفات النهج في نطاقات متعددة، في كل قسم من أقسام النهج.

هام

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

إشعار

يمكن أن يحتوي قسم نهج الواجهة الخلفية على عنصر نهج واحد فقط. بشكل افتراضي، تقوم إدارة واجهة برمجة التطبيقات بتكوين النهج forward-request في القسم الواجهة الخلفية في النطاق العمومي، والعنصر base في نطاقات أخرى.

النطاق العمومي

كُوِنَ النطاق العمومي لـ جميع واجهات برمجة التطبيقات في مثيل APIM الخاص بك.

  1. في شريط التنقل الأيسر لمثيل APIM، حدد ِAPIs>All APIs.

  2. حدد علامة التبويب Design.

    تكوين النهج على نطاق المنتج

  3. في قسم النهج، حدد + Add policy لاستخدام محرر نهج يستند إلى نموذج، أو حدد الأيقونة </> (محرر التعليمات البرمجية) لإضافة XML وتحريره مباشرة.

  4. حدد Save لنشر التغييرات إلى بوابة APIM على الفور.

نطاق المنتج

كون نطاق المنتج للمنتج المحدد.

  1. في القائمة اليسرى، حدد Products، ثم حدد منتجاً تريد تطبيق النهج عليه.

  2. في نافذة المنتج، حدد Policies.

    تكوين النهج على النطاق العالمي

  3. في قسم النهج، حدد + Add policy لاستخدام محرر نهج يستند إلى نموذج، أو حدد الأيقونة </> (محرر التعليمات البرمجية) لإضافة XML وتحريره مباشرة.

  4. حدد Save لنشر التغييرات إلى بوابة APIM على الفور.

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

كُوِنَ نطاق واجهة برمجة التطبيقات لجميع عمليات واجهة برمجة التطبيقات المحددة.

  1. في التنقل الأيسر لمثيل APIM، حدد واجهات برمجة التطبيقات، ثم حدد واجهة برمجة التطبيقات التي تريد تطبيق النهج عليها.

  2. حدد علامة التبويب Design.

  3. حدد «جميع العمليات».

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

  4. في قسم النهج، حدد + Add policy لاستخدام محرر نهج يستند إلى نموذج، أو حدد الأيقونة </> (محرر التعليمات البرمجية) لإضافة XML وتحريره مباشرة.

  5. حدد Save لنشر التغييرات إلى بوابة APIM على الفور.

نطاق العملية

كون نطاق العملية للعملية المحددة.

  1. في شريط التنقل الأيسر لمثيل API Management، حدد APIs.

  2. حدد علامة التبويب Design.

  3. حدد العملية التي تريد تطبيق النُهج عليها.

    تكوين النهج على نطاق العملية

  4. في قسم النهج، حدد + Add policy لاستخدام محرر نهج يستند إلى نموذج، أو حدد الأيقونة </> (محرر التعليمات البرمجية) لإضافة XML وتحريره مباشرة.

  5. حدد Save لنشر التغييرات إلى بوابة APIM على الفور.

إعادة استخدام التكوينات الخاصة بالنهج

يمكنك إنشاء أجزاء نهج قابلة لإعادة الاستخدام في مثيل APIM الخاص بك. أجزاء النهج هي عناصر XML تحتوي على تكوينات نهج واحد أو أكثر. تساعدك أجزاء النهج على تكوين النهج باستمرار والحفاظ على تعريفات النهج دون الحاجة إلى تكرار أو إعادة كتابة التعليمات البرمجية XML.

استخدم النهج include-fragment لإدراج جزء نهج في تعريف النهج.

استخدام العنصر base لتعيين ترتيب تقييم النهج

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

في APIM، حدد ترتيب تقييم النهج حسب موضع base العنصر في كل قسم في تعريف النهج في كل نطاق. يتضمن العنصر base النهج المكونة في هذا القسم في النطاق الأوسع التالي (الأصل). يتم تضمين العنصر base بشكل افتراضي في كل قسم نهج.

إشعار

لعرض النهج الفعالة في النطاق الحالي، أختر حساب النهج الفعال في محرر النهج.

لتعديل ترتيب تقييم النهج باستخدام محرر النهج:

  1. ابدأ بالتعريف في النطاق الأكثر ضيقاً الذي قمت بتكوينه، والذي ستطبقه APIM أولاً.

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

  2. ضع العنصر base داخل مقطع لتحديد مكان وراثة جميع النهج من المقطع المقابل في النطاق الأصل.

    على سبيل المثال، في القسم inbound الذي تم تكوينه في نطاق واجهة برمجة التطبيقات، ضع base عنصراً للتحكم في مكان وراثة النهج التي تم تكوينها في القسم inbound في النطاق العمومي. في المثال التالي، يتم تطبيق النهج الموروثة من النطاق العمومي قبل النهج ip-filter.

    <policies>
  <inbound>
      <base />
        <ip-filter action="allow">
            <address>10.100.7.1</address>
        </ip-filter>
  </inbound>
  [...]
</policies>

    إشعار

    • يمكنك وضع العنصر base قبل أو بعد أي عنصر نهج في مقطع.
    • إذا كنت تريد منع توريث النهج من النطاق الأصل، فقم بإزالة العنصر base. في معظم الحالات، لا يوصى بذلك. ومع ذلك، قد يكون مفيدا في حالات معينة، مثل عندما تريد تطبيق نهج مختلفة على عملية معينة مما تم تكوينه لنطاق API (جميع العمليات).

  3. استمر في تكوين العنصر base في تعريفات النهج في نطاقات أوسع بشكل متعاقب.

    لا يوجد نهج أصل للنهج العمومي ولا يكون لاستخدام العنصر base فيه أي تأثير.

الحصول على المساعدة في إنشاء النهج باستخدام Microsoft Copilot في Azure (معاينة)

يوفر Microsoft Copilot في Azure (معاينة) إمكانات تأليف النهج لإدارة واجهة برمجة تطبيقات Azure. استخدم Copilot في Azure في سياق محرر نهج APIM لإنشاء نهج تطابق متطلباتك المحددة دون معرفة بناء الجملة، أو قد كونت نهج مفسرة لك بالفعل.

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

المحتوى ذو الصلة

لمزيد من المعلومات حول العمل مع النُهج، راجع: