الگوی بد: تعریف چندین ProxyEndpoint در یک پراکسی API

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

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

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

الگوی بد

کارگزار نیابتی API می‌تواند یک یا چند نقطه پایانی نیابتی داشته باشد. تعریف چندین ProxyEndpoints سازوکار آسان و ساده‌ای برای پیاده‌سازی چندین API در یک پراکسی است. این کار به شما امکان می‌دهد سیاست‌ها و/یا منطق کسب‌وکار را قبل‌از و بعداز فراخوانی TargetEndpoint دوباره استفاده کنید.

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

تأثیر

چندین ProxyEndpoint در پراکسی API می‌تواند:

  • درک و نگهداری پراکسی API را برای توسعه‌دهندگان دشوار می‌کند.
  • تجزیه‌وتحلیل‌ها را مبهم کنید. به‌طور پیش‌فرض، داده‌های Analytics در سطح پراکسی تجمیع می‌شود. تفکیک سنجه‌ها براساس نقطه پایانی پراکسی وجود ندارد، مگراینکه گزارش‌های سفارشی ایجاد کنید.
  • عیب‌یابی کردن مشکلات مربوط به پراکسی‌های API را دشوار می‌کند.

روال مطلوب

وقتی درحال پیاده‌سازی پراکسی API جدید یا طراحی مجدد پراکسی API موجود هستید، از روال‌های مطلوب زیر استفاده کنید:

  1. یک پراکسی API با یک ProxyEndpoint پیاده‌سازی کنید.
  2. اگر چندین میانای برنامه‌سازی کاربردی وجود دارد که سرور هدف مشترک دارند و/یا به منطق یکسانی قبل‌از یا بعداز فراخوانی سرور هدف نیاز دارند، از جاری‌سازی‌های مشترک برای پیاده‌سازی چنین منطقی در کارگزاران میانای برنامه‌سازی کاربردی مختلف استفاده کنید.
  3. اگر چند API وجود دارد که مسیر پایه شروع مشترکی دارند، اما در پسوند متفاوت هستند، از جاری‌سازی‌های شرطی در یک ProxyEndpoint استفاده کنید.
  4. اگر کارگزار میانای برنامه‌سازی کاربردی با چندین «نقطه پایان کارگزار» وجود داشته باشد و مشکلی نداشته باشد، نیازی به انجام هیچ اقدامی نیست.

استفاده از یک ProxyEndpoint برای هر پراکسی API منجر به موارد زیر می‌شود:

  1. کارگزاران ساده‌تر و با نگهداری آسان‌تر
  2. اطلاعات بهتر در Analytics، مثل عملکرد پراکسی و زمان پاسخ هدف، به‌صورت جداگانه گزارش خواهد شد به‌جای اینکه برای همه ProxyEndpoints جمع‌آوری شود
  3. عیب‌یابی و حل مشکل سریع‌تر

مطالعه بیشتر