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

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

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

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

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

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

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

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

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

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

شما از طریق متغیرهای جریان ایجاد شده توسط پراکسی های 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 را سفارشی کنید. کنترل‌کننده‌های خطا به شما امکان کنترل پیام‌های خطا را می‌دهند که آیا خطا از کد خود شما منشأ می‌گیرد یا از یک مؤلفه موجود (مانند یک خط‌مشی).

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