درحال مشاهده اسناد Apigee Edge هستید.
به
اسناد Apigee X بروید. اطلاعات
افزودن قابلیت‌های مبتنی بر خط‌مشی به پراکسی میانای برنامه‌سازی کاربردی فرایندی دو مرحله‌ای است:
- نمونه‌ای از نوع خط‌مشی را پیکربندی کنید.
- نمونه خط‌مشی را به «جریان» پیوست کنید.
نمودار زیر رابطه بین خط‌مشی‌ها و «جریان‌ها» را نشان می‌دهد. همان‌طور که می‌بینید، خط‌مشی به‌عنوان «مرحله» پردازش به «جریان» پیوست می‌شود. برای پیکربندی رفتار موردنظرتان برای میانای برنامه‌سازی کاربردی، باید کمی درباره «جریان‌ها» بدانید. (این موضوع قبلاً در پیکربندی جریان‌ها پوشش داده شده است.)
یکی از انواع خط‌مشی که معمولاً استفاده می‌شود SpikeArrest است. SpikeArrest از افزایش ناگهانی ترافیک پیام که ممکن است سرویس‌های زیرینه شما را غرق کند جلوگیری می‌کند.
پیوست کردن خط‌مشی به جریان
برای پیوست کردن خط‌مشی به «جریان»:
- یک پراکسی API انتخاب کنید و به نمای توسعه پیمایش کنید.
- در «ویرایشگر پراکسی API»، جریانی را که می‌خواهید خط‌مشی را در
«ناوبر» به آن پیوست کنید انتخاب کنید.
برای مثال، جریان «جریان پیش‌از اجرا» برای نقطه پایانی پیش‌فرض پراکسی API در شکل زیر انتخاب شده است:
- در نمای «طراحی»، روی +مرحله مرتبط با درخواست یا جریان
پاسخ کلیک کنید تا خط‌مشی را پیوست کنید. برای مثال:
کادر گفتگوی «افزودن مرحله» باز می‌شود و فهرست دسته‌بندی‌شده‌ای از خط‌مشی‌ها را نمایش می‌دهد.
- پیمایش کنید و نوع خط‌مشی‌ای را که می‌خواهید به جاری‌سازی انتخاب‌شده پیوست کنید انتخاب کنید.
- فیلدهای زیر را اصلاح کنید.
-
نام نمایشی: نام نمایشی یکتا برای خط‌مشی. واسط کاربر نام پیش‌فرضی تولید خواهد کرد، اما توصیه می‌شود نامی توصیفی برای خط‌مشی ایجاد کنید. این کار باعث می‌شود توسعه‌دهندگان دیگر در سازمانتان به‌راحتی متوجه شوند که هدف این خط‌مشی چیست.
-
نام: نام منحصربه‌فرد برای خط‌مشی. نام خط‌مشی با نام نمایشی مطابقت دارد به‌جز در موارد زیر:
-
فاصله‌ها با خط تیره جایگزین می‌شوند.
-
خط تیره متوالی با یک خط تیره جایگزین می‌شود.
-
به‌جز خط تیره، زیرخط، و فاصله (که همان‌طور که در بالا ذکر شد جایگزین می‌شوند)، نویسه‌هایی که الفباعددی نیستند، مثل علامت پوند، علامت درصد، علامت امپرسند، و غیره، برداشته می‌شوند.
-
-
- روی افزودن کلیک کنید.
خط‌مشی به جاری‌سازی انتخاب‌شده پیوست شده است.
پس‌از پیوست شدن خط‌مشی، خط‌مشی را در نمای طراح برای جاری‌سازی، در این مثال PreFlow نقطه پایانی پراکسی پیش‌فرض، و در فهرست خط‌مشی‌ها در قاب «پیمایش» خواهید دید. نمای کد که XML خط‌مشی جدید پیوست‌شده را نمایش می‌دهد، در زیر نمای طراح نمایش داده می‌شود. Edge نمونه‌ای از خط‌مشی را تولید می‌کند که حاوی مجموعه‌ای از مقادیر پیش‌فرض منطقی است.
افزودن خط‌مشی بدون پیوست کردن آن به جریان
برای افزودن خط‌مشی بدون پیوست کردن آن به یک جریان، که برای مدیریت خطاها مفید است، در نوار خط‌مشی‌ها در نمای پیمایشگر روی + کلیک کنید تا کادر گفتگوی افزودن خط‌مشی باز شود و خط‌مشی را اضافه کنید (همان‌طور که در مراحل ۴ تا ۶ بخش قبلی توضیح داده شده است).
خط‌مشی‌ای که به هیچ جریانی پیوست نشده باشد با نماد «جداشده» در فهرست خط‌مشی‌ها علامت‌گذاری می‌شود، همان‌طور که در کنار خط‌مشی پیام کلید API نشان‌داده‌شده در شکل قبلی نشان داده شده است.
پس‌از ایجاد خط‌مشی، می‌توانید آن را با کشیدن و رها کردن از فهرست خط‌مشی‌ها به جریان موردنظر در نمای طراح به جریان پیوست کنید.
جدا کردن خط‌مشی‌ها از یک جریان
برای جدا کردن خط‌مشی از «جریان»، «جریان» را انتخاب کنید. موشواره را روی نماد خط‌مشی در نمای طراح «جریان» نگه دارید. روی X در دایره‌ای که در نماد ظاهر می‌شود کلیک کنید.
درحال حذف کردن نمونه خط‌مشی
برای حذف نمونه خط‌مشی، نشانگر موشواره را روی ورودی خط‌مشی در نمای Navigator نگه‌دارید. روی 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 آن در نمای
کد پیکربندی کنید. برای مثال، نرخ پیام اوج برای خط‌مشی «مهار جهش» در ابتدا روی ۳۰ پیام در ثانیه تنظیم می‌شود. می‌توانید نرخ اوج را با تغییر مقدار عنصر <Rate> در XML خط‌مشی تغییر دهید. برای جزئیات بیشتر درباره
پیکربندی خط‌مشی‌ها، مرجع خط‌مشی را ببینید.
همچنین می‌توانید خط‌مشی‌ها را در نمای کد برش دهید و جای‌گذاری کنید. این روشی عالی برای استفاده مجدد از خط‌مشی‌های نمونه‌های دردسترس در GitHub است.
وقتی در نمای کد تغییراتی در تعریف خط‌مشی ایجاد می‌کنید، تغییرات در بازرس دارایی منعکس می‌شود. برعکس این موضوع نیز صادق است — تغییراتی در بازرس دارایی ایجاد کنید و این تغییرات در XML در نمای کد ظاهر می‌شود.
برای مستندات مربوط به خط‌مشی «سهمیه» که در این موضوع استفاده شده است، خط‌مشی سهمیه را ببینید.