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

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

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

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

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

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

برای مرور کلی در مورد پروکسی‌های API، به بخش آشنایی با APIها و پروکسی‌های API مراجعه کنید.

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

در هر برنامه‌ای، داده‌ها توسط منطق شرط در برنامه جریان می‌یابند. در Apigee Edge، مسیر پردازش از جریان‌ها تشکیل شده است. یک جریان، دنباله ای از مراحل (یا "گام‌ها") است که مسیر پردازش یک پروکسی API را تشکیل می‌دهند. جریان‌ها به این صورت هستند که Apigee Edge مکان‌هایی را برای شما فراهم می‌کند تا منطق و رفتار را در مکان‌های خاص از کلاینت به منبع backend و سپس به کلاینت اعمال کنید.

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

شما از طریق متغیرهای جریان ایجاد شده توسط پروکسی‌های API به داده‌های وضعیت دسترسی دارید

یک پروکسی API به متغیرهایی که وضعیت اجرا را نشان می‌دهند دسترسی دارد. شما می‌توانید از طریق XML که پروکسی‌ها و سیاست‌های API شما را پیکربندی می‌کند، به این متغیرها دسترسی داشته باشید. همچنین می‌توانید هنگام توسعه یک پروکسی API با یک زبان رویه‌ای مانند جاوا، جاوا اسکریپت یا پایتون به آنها دسترسی داشته باشید.

این متغیرها توسط Apigee Edge نگهداری می‌شوند. برخی از آنها به طور پیش‌فرض وجود دارند، معمولاً به این دلیل که با کاری که پروکسی‌های API انجام می‌دهند مشترک هستند (مثلاً به این دلیل که بخشی از یک درخواست HTTP هستند). همچنین می‌توانید متغیرهای خودتان را برای برآورده کردن یک الزام منطقی ایجاد کنید.

برای اطلاعات بیشتر در مورد متغیرها، به مدیریت وضعیت پروکسی با متغیرهای جریان مراجعه کنید.

می‌توانید پروکسی‌های API را به صورت مشروط اجرا کنید

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

برای اطلاعات بیشتر در مورد اجرای شرطی، به متغیرهای جریان و شرط‌ها مراجعه کنید.

شما بیشتر منطق را در یک پروکسی API با استفاده از سیاست‌ها پیاده‌سازی می‌کنید

بیشتر منطقی که به یک پروکسی API اضافه می‌کنید، به صورت سیاست‌ها بسته‌بندی می‌شود. یک سیاست، یک جزء Apigee Edge است که منطق یک حوزه عملکردی، مانند امنیت یا مدیریت ترافیک، را کپسوله‌سازی می‌کند. شما یک سیاست را با XML پیکربندی می‌کنید که ویژگی‌های منطق زیربنایی را تعیین می‌کند. شما سیاست‌ها را در یک توالی از "مراحل" در یک جریان مرتب می‌کنید، به طوری که پروکسی API شما منطق را به بهترین ترتیب برای اهداف پروکسی شما اجرا کند.

برای اطلاعات بیشتر در مورد سیاست‌ها، به «سیاست چیست؟» مراجعه کنید.

شما می‌توانید مجموعه‌هایی از قابلیت‌ها را که قابلیت استفاده مجدد دارند، اضافه کنید.

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

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

شما می‌توانید با ابزار Trace، پروکسی را اشکال‌زدایی کنید.

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

برای اطلاعات بیشتر در مورد اشکال‌زدایی با Trace، به استفاده از ابزار Trace مراجعه کنید.

شما خطاهای پروکسی API را به عنوان خطا مدیریت می‌کنید

با پیکربندی یک مدیریت‌کننده خطا، می‌توانید خطایی که به یک کلاینت API برگردانده می‌شود را سفارشی کنید. مدیریت‌کننده‌های خطا به شما امکان کنترل پیام‌های خطا را می‌دهند، چه خطا از کد خودتان سرچشمه گرفته باشد و چه از یک مؤلفه‌ی گنجانده شده (مانند یک خط‌مشی).

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