استجابة الإرجاع
ينطبق على: جميع مستويات إدارة واجهة برمجة التطبيقات
يلغي النهج return-response تنفيذ البنية الأساسية لبرنامج ربط العمليات التجارية ويعيد إما استجابة افتراضية أو مخصصة إلى المتصل. الاستجابة الافتراضية 200 OK دون نص. يمكن تحديد الاستجابة المخصصة عبر متغير سياق أو عبارات نَهج. عند توفير كليهما، يتم تعديل الاستجابة الواردة في متغير السياق بواسطة عبارات النهج قبل إرجاعها إلى المتصل.
إشعار
تعيين عناصر النهج والعناصر التابعة بالترتيب الوارد في بيان النهج. تعلم كيفية إعداد نُهج APIM أو تعديلها.
نهج السياسة
<return-response response-variable-name="existing context variable">
<set-status>...</set-status>
<set-header>...</set-header>
<set-body>...</set-body>
</return-response>
سمات
| السمة | الوصف | مطلوبة | افتراضي |
|---|---|---|---|
| اسم متغير الاستجابة | اسم متغير السياق المشار إليه من، على سبيل المثال، نهج طلب إرسال المصدر ويحتوي على كائنResponse. تعبيرات النهج غير مسموح بها. |
لا | غير متاح |
عناصر
| العنصر | الوصف | مطلوب |
|---|---|---|
| تعيين الحالة | تعيين رمز الحالة للاستجابة. | لا |
| تعيين العنوان | تعيين رأس في الاستجابة. | لا |
| تعيين النص الأساسي | تعيين النص الأساسي في الاستجابة. | لا |
الاستخدام
- أقسام النهج: واردة وصادرة وخلفية وعند الخطأ
- نطاقات النهج: العمومية، ومساحة العمل، والمنتج، وواجهة برمجة التطبيقات، والتشغيل
- البوابات: الكلاسيكية، الإصدار 2، الاستهلاك، المستضافة ذاتيا، مساحة العمل
ملاحظات الاستخدام
- لا يعمل القالب السائل عند تحديده داخل النص الأساسي (تعيين باستخدام
set-body) للنهجreturn-response. يلغي النهجreturn-responseمسار التنفيذ الحالي ويزيل نص الطلب ونص الاستجابة في السياق الحالي. ونتيجة لذلك، يتلقى القالب السائل المحدد داخل النهج سلسلة فارغة كإدخل ولن ينتج الإخراج المتوقع.
مثال
<return-response>
<set-status code="401" reason="Unauthorized"/>
<set-header name="WWW-Authenticate" exists-action="override">
<value>Bearer error="invalid_token"</value>
</set-header>
</return-response>
النهج ذات الصلة
المحتوى ذو الصلة
لمزيد من المعلومات حول العمل مع النُهج، راجع: