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

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

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

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

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

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

برای نمای کلی کارگزاران API، درک API و کارگزاران API را ببینید.

ترتیب منطق پراکسی میانای برنامه‌سازی کاربردی را بااستفاده از جریان‌ها تنظیم می‌کنید

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

می‌توانید پراکسی را با ابزار «ردیابی» اشکال‌زدایی کنید

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

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

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

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

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