Antipattern: چندین ProxyEndpoint را در یک پراکسی API تعریف کنید

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

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

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

ضدالگو

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

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

تأثیر

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

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

بهترین شیوه

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

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

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

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

مطالعه بیشتر