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

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

پیکربندی ProxyEndpoint روشی را که برنامه‌های سرویس گیرنده APIها را از طریق Apigee Edge مصرف می‌کنند، تعریف می‌کند. ProxyEndpoint نشانی وب پراکسی 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، مانند عملکرد پروکسی و زمان پاسخ هدف، به‌جای جمع‌آوری برای همه ProxyEndpoints، به‌صورت جداگانه گزارش می‌شود.
  3. عیب یابی سریع تر و رفع مشکل

در ادامه مطلب

،

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

پیکربندی ProxyEndpoint روشی را که برنامه‌های سرویس گیرنده APIها را از طریق Apigee Edge مصرف می‌کنند، تعریف می‌کند. ProxyEndpoint نشانی وب پراکسی 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، مانند عملکرد پروکسی و زمان پاسخ هدف، به‌جای جمع‌آوری برای همه ProxyEndpoints، به‌صورت جداگانه گزارش می‌شود.
  3. عیب یابی سریع تر و رفع مشکل

در ادامه مطلب