سیاست چیست؟

شما در حال مشاهده اسناد Apigee Edge هستید.
به مستندات Apigee X بروید . اطلاعات

Apigee Edge شما را قادر می سازد تا با استفاده از سیاست ها، رفتار API را بدون نوشتن هیچ کدی «برنامه ریزی» کنید. یک خط مشی مانند یک ماژول است که یک عملکرد مدیریتی خاص و محدود را پیاده سازی می کند. خط‌مشی‌ها به گونه‌ای طراحی شده‌اند که به شما امکان می‌دهند انواع معمولی از قابلیت‌های مدیریتی را به راحتی و با اطمینان به یک API اضافه کنید. خط‌مشی‌ها ویژگی‌هایی مانند امنیت، محدودیت نرخ، قابلیت‌های تبدیل و میانجی‌گری را ارائه می‌کنند که شما را از کدنویسی و حفظ این عملکرد به تنهایی نجات می‌دهد.

شما محدود به مجموعه ای از انواع خط مشی های ارائه شده توسط Apigee Edge نیستید. همچنین می‌توانید اسکریپت‌ها و کدهای سفارشی بنویسید (مانند برنامه‌های جاوا اسکریپت و Node.js)، که عملکرد پراکسی API را گسترش می‌دهد و به شما امکان می‌دهد تا در کنار قابلیت‌های مدیریتی پایه‌ای که توسط Apigee Policies پشتیبانی می‌شود، نوآوری کنید.

برای آشنایی با الحاق سیاست و اجرای آن، این ویدئو را تماشا کنید.

انواع خط مشی

از نظر فنی، یک خط مشی یک فایل پیکربندی با فرمت XML است. ساختار هر نوع خط مشی (به عنوان مثال، عناصر پیکربندی مورد نیاز و اختیاری) توسط یک طرح XML تعریف می شود. اگر به ابزارهای XML مسلط هستید، ارزش دارد که با طرح‌های خط‌مشی در نمونه‌های پلتفرم API در Github آشنا شوید.

انواع Edge Policy به دسته های کاربردی زیر گروه بندی می شوند:

مدیریت ترافیک

خط‌مشی‌های دسته مدیریت ترافیک شما را قادر می‌سازد تا جریان درخواست و پیام‌های پاسخ را از طریق یک پروکسی API کنترل کنید. این سیاست ها هم از کنترل عملیاتی و هم در سطح تجاری پشتیبانی می کنند. آنها به شما کنترل بر روی توان خام را می دهند و همچنین می توانند ترافیک را بر اساس هر برنامه کنترل کنند. انواع خط‌مشی مدیریت ترافیک به شما امکان می‌دهند تا سهمیه‌ها را اعمال کنید، و همچنین به شما کمک می‌کنند تا حملات انکار سرویس را کاهش دهید.

امنیت

خط‌مشی‌های دسته امنیتی از احراز هویت، مجوز، و همچنین امنیت مبتنی بر محتوا پشتیبانی می‌کنند.

میانجیگری

خط‌مشی‌های دسته میانجی به شما امکان می‌دهند تا پیام‌ها را هنگام عبور از پروکسی‌های API به طور فعال دستکاری کنید. آنها شما را قادر می سازند فرمت های پیام را از XML به JSON (و بالعکس) تبدیل کنید یا یک فرمت XML را به فرمت XML دیگر تبدیل کنید. آنها همچنین به شما امکان می دهند پیام ها را تجزیه کنید، پیام های جدید تولید کنید و مقادیر پیام های خروجی را تغییر دهید. خط‌مشی‌های میانجی‌گری همچنین با سرویس‌های پایه‌ای که توسط سرویس‌های API در معرض دید قرار می‌گیرند، تعامل دارند و به شما امکان می‌دهند داده‌های مربوط به برنامه‌ها، توسعه‌دهندگان، نشانه‌های امنیتی و محصولات API را در زمان اجرا بازیابی کنید.

پسوند

خط‌مشی‌ها در دسته برنامه‌های افزودنی به شما امکان می‌دهند تا از قابلیت توسعه‌پذیری سرویس‌های API برای پیاده‌سازی رفتار سفارشی در زبان برنامه‌نویسی مورد نظر خود استفاده کنید.

هر نوع خط مشی با جزئیات در نمای کلی مرجع خط مشی مستند شده است. این مبحث تعامل کلی را نشان می‌دهد، به شما نشان می‌دهد که چگونه سیاست‌ها را ایجاد کنید، و چگونه آنها را به جریان‌ها در یک پیکربندی پراکسی API متصل کنید.

اعمال تغییرات سیاست

برای اعمال تغییرات خط مشی، باید ویرایش پروکسی API را در یک محیط مستقر کنید. پس از پیوست کردن یک خط مشی یا ایجاد تغییرات در یک خط مشی موجود، از رابط کاربری مدیریت یا API مدیریت برای اعمال تغییرات استفاده کنید.

تأیید اجرای سیاست

برای تأیید اینکه یک خط مشی به درستی اجرا شده است، API باید توسط یک سرویس گیرنده HTTP فراخوانی شود. برای تأیید این پیکربندی سهمیه، درخواست‌های متعددی را به API ارسال کنید که از حد سهمیه‌ای که در خط‌مشی سهمیه تعیین کرده‌اید فراتر رود. (مسیر URI که به عنوان تنظیم مسیر پایه در ProxyEndpoint پیکربندی شده است، در درخواست زیر /weather است).

http://{org_name}-test.apigee.net/weather/forecastrss?w=12797282

پس از ارسال بیش از 1 درخواست در عرض یک دقیقه، باید پیام خطای زیر را مشاهده کنید:

{  
   "fault":{  
      "faultstring":"policies.ratelimit.QuotaViolation",
      "detail":{  
         "errorcode":"policies.ratelimit.QuotaViolation"
      }
   }
}

این نشان می دهد که خط مشی Quota توسط سرویس های API اجرا می شود.

مدیریت خطا مبتنی بر سیاست

به فرمت پیام خطای بالا توجه کنید. این شامل یک ویژگی faultstring و یک ویژگی errorcode است. در بسیاری از موارد، برای مدیریت این خطاها باید برخی رفتارها را اجرا کنید. به عنوان مثال، ممکن است بخواهید یک پیام سفارشی برای برنامه‌نویسی که برنامه‌اش از حد نصاب بیشتر شده است، ارسال کنید.

برای اطلاعات بیشتر در مورد رسیدگی به خطا، به رسیدگی به خطاها مراجعه کنید.

بهترین شیوه ها: مجموعه سیاست های مشترک

برای برآورده کردن الزامات مدیریتی اولیه، پراکسی‌های API معمولاً سیاست‌های زیر را اعمال می‌کنند:

اعتبار سنجی کلید API پایه

جریان درخواست ProxyEndpoint:
  1. SpikeArrest
  2. XMLThreatProtection یا JSONThreatProtection
  3. اعتبار سنجی کلید API
  4. سهمیه
  5. ResponseCache
جریان پاسخ ProxyEndpoint:
  1. ResponseCache

تبدیل اولیه: JSON به XML

جریان درخواست:
  1. SpikeArrest
  2. JSONThreatProtection
  3. اعتبار سنجی کلید API
  4. سهمیه
  5. JSONToXML
جریان پاسخ:
  1. XMLToJSON
  2. ResponseCache