شما در حال مشاهده مستندات Apigee Edge هستید.
به مستندات Apigee X مراجعه کنید . اطلاعات
نمونه‌های API مربوط به Apigee Edge شامل پروکسی‌های API نمونه، سیاست‌ها، کد و ابزارهایی است که قابلیت‌های سرویس‌های API مربوط به Apigee Edge را که در زیر توضیح داده شده است، نشان می‌دهد.
برای دستورالعمل‌های استفاده از نمونه‌ها، به بخش «استفاده از نمونه پروکسی‌های API» مراجعه کنید.
با انجام دادن یاد بگیرید
آیا می‌خواهید فوراً دست به کار شوید و یک پایگاه دانش قوی در مورد Apigee Edge بسازید؟ ما یک کتابخانه از نمونه‌های «learn-edge» در GitHub داریم که به شما امکان می‌دهد به سرعت برخی از پروکسی‌های نمونه را مستقر، فراخوانی و ردیابی کنید، که از ساده‌ترین پروکسی شروع می‌شود و به پروکسی‌هایی می‌رسد که اعتبارسنجی کلید API، سهمیه‌بندی، ذخیره‌سازی پاسخ، مدیریت خطا و موارد دیگر را نشان می‌دهند.
وقتی مخزن را کپی کردید و محیط خود را تنظیم کردید (فقط چند دقیقه طول می‌کشد)، می‌توانید هر نمونه را در کمتر از یک دقیقه امتحان کنید. و از آنجا که هر نمونه یک نسخه جدید از همان پروکسی ایجاد می‌کند، محیط شما با تعداد زیادی نمونه شلوغ نمی‌شود. می‌توانید نسخه‌ها را تغییر دهید، یک نسخه متفاوت را در رابط کاربری مدیریت مجدداً مستقر کنید و هر زمان که خواستید به کد پروکسی نگاه کنید. فایل readme برای هر نمونه همچنین خلاصه‌ای از عملکرد نمونه و نحوه تنظیم آن را به شما ارائه می‌دهد.
امتحانش کن! https://github.com/apigee/api-platform-samples/tree/master/learn-edge
نمونه‌های کتاب آشپزی داک
مجموعه‌ای از نمونه‌ها برای مباحث کتاب آشپزی پروکسی API ارائه شده است.
| نام | توضیحات | انواع سیاست | منابع |
|---|---|---|---|
| کتاب آشپزی جاوا اسکریپت | یک قطعه کد ساده جاوا اسکریپت را نشان می‌دهد که هدرهای HTTP را از متغیرها اضافه می‌کند، یک گزارش آب و هوا با فرمت XML را از JSON به XML تبدیل می‌کند و محتوا را برای کلاینت‌های موبایل کوتاه می‌کند. | به حداقل رساندن.js setHeaders.js | |
| کتاب آشپزی ترکیبی جاوا اسکریپت | یک برنامه کامل جاوا اسکریپت که API های عمومی را فراخوانی می‌کند، نتایج را ترکیب می‌کند و یک پاسخ غنی‌شده برای برنامه کلاینت تولید می‌کند. (توجه: این پروکسی API همان عملکرد policy-mashup را پیاده‌سازی می‌کند و نشان می‌دهد که می‌توان با استفاده از تکنیک‌های مختلف به همان مشکل پرداخت.) | جاوا اسکریپت | MashItUp.js |
| جاوا-سلام | فراخوانی ساده‌ی سلام دنیا در جاوا. | جاوا کال‌اوت | جاوا سلام.جاوا |
| کتاب آشپزی جاوا | محتوای پاسخ و هدرها را به حروف بزرگ تبدیل می‌کند. | جاوا کال‌اوت | پاسخ با حروف بزرگ.java |
| ویژگی‌های جاوا | نحوه استفاده از ویژگی‌ها (properties) را در یک فراخوانی جاوا نشان می‌دهد. | جاوا کال‌اوت | خواص جاوا.جاوا |
| خطای جاوا | الگوهای مدیریت خطا را که می‌توانید در کد جاوا Callout استفاده کنید، نشان می‌دهد. | جاوا کال‌اوت | خطای جاوا.java |
| کتاب آشپزی ترکیبی از سیاست‌ها | یک برنامه کامل که از ترکیب سیاست‌ها برای فراخوانی دو API عمومی استفاده می‌کند، نتایج را ترکیب می‌کند و یک پاسخ غنی‌شده برای برنامه کلاینت تولید می‌کند. (توجه: این پروکسی API همان عملکرد javascript-mashup را پیاده‌سازی می‌کند و نشان می‌دهد که می‌توان با استفاده از تکنیک‌های مختلف، به همان مشکل پرداخت.) | اختصاص پیام تماس با سرویس متغیرهای استخراج‌شده جاوا اسکریپت XMLToJSON | GenerateResponse.js |
نمونه پروکسی‌های API
پروکسی‌های API زیر در GitHub قرار دارند، جایی که صفحات readme توضیحات مفصلی از نمونه‌ها ارائه می‌دهند. اگر به نحوه عملکرد یک سیاست خاص در یک نمونه علاقه‌مند هستید، در ستون Policy Types در زیر، سیاست مورد نظر خود را جستجو کنید، سپس روی نام نمونه در ستون Name کلیک کنید. (سیاست‌ها به صفحات مرجع مربوطه در اسناد پیوند داده شده‌اند.)
مرجع و ابزارها
علاوه بر نمونه‌های کتاب آشپزی و نمونه‌های پروکسی در جداول بالا، نمونه‌های Edge GitHub نیز شامل این منابع هستند:
| نام | توضیحات | انواع سیاست | منابع |
|---|---|---|---|
| محافظت در برابر egex در r | سیاست محافظت در برابر تهدید عبارات منظم می‌تواند از APIهای بک‌اند و میکروسرویس‌های شما در برابر حملات تزریق SQL محافظت کند. | ناموجود | |
| کلید مخفی oauth-validate | شما در حال پیاده‌سازی جریان نوع اعطای رمز عبور OAuth هستید. قبل از فراخوانی یک ارائه‌دهنده هویت خارجی برای اعتبارسنجی اعتبارنامه‌های کاربر، باید هم کلید کلاینت برنامه و هم رمز عبور را در Edge اعتبارسنجی کنید. | OAuthV2 ، موارد دیگر | ناموجود |
| تطبیق الگو-شرط | این پروکسی به شما امکان می‌دهد به راحتی دستورات شرطی را در یک جریان پروکسی API امتحان و آزمایش کنید. | اختصاص پیام | ناموجود |
| دسترسی-نهاد | نحوه بازیابی پروفایل‌های مربوط به موجودیت‌ها از پایگاه داده Apigee Edge را نشان می‌دهد. | اختصاص پیام موجودیت دسترسی متغیرهای استخراج‌شده | هیچ کدام |
| آپیکی | اعتبارسنجی کلید API ساده را پیاده‌سازی می‌کند | تأیید کلید API اختصاص پیام سهمیه | هیچ کدام |
| فراخوانی ناهمگام | یک فراخوانی ناهمزمان ساده را با استفاده از httpClient جاوا اسکریپت نشان می‌دهد. | جاوا اسکریپت | assemble_response.js فراخوانی.js |
| رمزگذار base64 | نحوه فراخوانی کدهای جاوا اسکریپت از منابع جاوا اسکریپت در پروکسی‌های API را نشان می‌دهد. | اختصاص پیام جاوا اسکریپت | هسته-min.js enc-utf16-min.js enc-base64-min.js کدنویسی سربرگ اصلی (codeAuthHeader.js) |
| سیاست مشروط | اجرای سیاست شرطی ساده را پیاده‌سازی می‌کند. هنگامی که یک درخواست شامل یک هدر HTTP با زمان پاسخ: درست باشد، یک سیاست، یک اسکریپت پایتون را اجرا می‌کند که مجموعه‌ای از معیارهای عملکرد را به پیام پاسخ، به عنوان هدرهای HTTP، اضافه می‌کند. | اسکریپت (پایتون) | تایمر.py |
| نقطه پایانی پویا | مسیریابی شرطی ساده را در یک سناریوی کمی پیچیده‌تر پیاده‌سازی می‌کند که دو URL و یک مسیر پیش‌فرض را تعریف می‌کند. | هیچ کدام | هیچ کدام |
| یادداشت‌های انتشار جیرا | این پروکسی API است که توسط تیم مستندات Apigee برای تولید یادداشت‌های انتشار از Jira استفاده می‌شود. | JSONToXML XSL | فایل releasenotes_api.xsl |
| میانجیگری اعتبارنامه کربروس | این نمونه نحوه انجام Kerberos Credential Mediation را در Apigee Edge نشان می‌دهد. | جاوا کال‌اوت | فایل JAR جاوا |
| oauth-پیشرفته | یک مثال کامل و کاربردی از جریان نوع اعطای کد مجوز، با Apigee Edge به عنوان سرور مجوز. | ایجاد توکن دسترسی بسیاری دیگر... | کد مثال را ببینید |
| اعتبارنامه‌های کلاینت oauth | یک نقطه پایانی توکن OAuth 2.0 کاملاً کاربردی را نشان می‌دهد که برای نوع اعطای اعتبارنامه‌های کلاینت پیکربندی شده است. | ایجاد توکن دسترسی | هیچ کدام |
| ورود به سیستم oauth | منسوخ شده. توصیه می‌کنیم به جای آن، نمونه oauth-advanced را بررسی کنید. | ||
| کلید مخفی oauth-validate | تکنیکی را برای اعتبارسنجی کلید و رمز کلاینت قبل از فراخوانی یک ارائه‌دهنده هویت برای اعتبارسنجی اعتبارنامه‌های کاربر در جریان اعطای نوع رمز عبور نشان می‌دهد. | OAuthV2 اختصاص پیام متغیرهای استخراج‌شده تماس با سرویس RaiseFault | هیچ کدام |
| oauth-verify-accesstoken | یک پروکسی API را نشان می‌دهد که برای اعتبارسنجی توکن‌های دسترسی OAuth 2.0 و تأیید Quota پیکربندی شده است. | تأیید دسترسی توکن سهمیه | هیچ کدام |
| oauth10a-3legged | پیکربندی سه‌پایه‌ی OAuth 1.0a را نشان می‌دهد. | تولید توکن Acess ایجاد درخواست توکن تماس با سرویس تأیید دسترسی توکن | هیچ کدام |
| خروجی-oauth | از API مترجم مایکروسافت آژور برای ترجمه توییت‌ها استفاده می‌کند. برای انجام این کار، یک فراخوانی خروجی برای دریافت توکن دسترسی OAuth انجام می‌دهد و سپس توکن را با استفاده از سیاست‌های ذخیره‌سازی سرویس‌های API ذخیره می‌کند و هر بار که یک فراخوانی خروجی انجام می‌شود، توکن ذخیره شده را دوباره استفاده می‌کند. همچنین، شامل یک برنامه مرورگر نمایشی است که برای فراخوانی پروکسی API استفاده می‌شود. | اختصاص پیام جستجو کش PopulateCache جاوا اسکریپت | api-config.js دریافت توکن api.js translate-query.js translate-results.js |
| صفحه بندی | یک پیام پاسخ XML را بر اساس پارامترهای limit و offset ارائه شده توسط کلاینت، صفحه بندی می‌کند. | اختصاص پیام متغیرهای استخراج‌شده پاسخ‌رسان تأیید کلید API XSL | صفحه بندی.xslt |
| حافظه پنهان پاسخ | نحوه ذخیره پیش‌بینی‌های آب و هوا در Edge به مدت 10 دقیقه را نشان می‌دهد. | پاسخ‌رسان اختصاص پیام | هیچ کدام |
| پایتون ساده | یک سناریوی ساده از پیوست کردن یک اسکریپت پایتون را نشان می‌دهد. پاسخی که یک مقدار هدر به آن اضافه می‌کند. | اسکریپت (پایتون) | setHeader.py |
| صابون | یک تبدیل XSL را نشان می‌دهد که یک فایل WSDL را در پاسخ به درخواستی با پارامتر پرس‌وجوی ?wsdl بازنویسی می‌کند. | اختصاص پیام متغیرهای استخراج‌شده اسکریپت (پایتون) XSL | محاسبه‌شده.py fixwsdl.xsl |
| پخش جریانی | پیکربندی جریان HTTP را نشان می‌دهد. | هیچ کدام | هیچ کدام |
| تغییر مسیر هدف | استفاده از جاوا اسکریپت را برای انتخاب پویای یک URL هدف بر اساس محتوای یک پیام درخواست نشان می‌دهد. | متغیرهای استخراج‌شده جاوا اسکریپت | بازنویسی TargetUrl.js |
| تایم‌لاین توییتر موبایل | نحوه استفاده از جاوا اسکریپت برای حذف پارامترهای غیرضروری از توییت‌ها را نشان می‌دهد که منجر به یک جدول زمانی توییتر ساده و کاربرپسند می‌شود که برای دستگاه‌های تلفن همراه با محدودیت منابع مناسب است. | اختصاص پیام جاوا اسکریپت | MobileTimeline.js |
| توییتر-oembed | پاسخ‌های جدول زمانی (مثلاً از statuses/user_timeline.json) را به یک پاسخ oEmbed تبدیل می‌کند که شامل داده‌های جدول زمانی به عنوان محتوای غنی HTML است. | اختصاص پیام جاوا اسکریپت | جستجو-oembed.js |
| متغیرها | نحوه استخراج و تنظیم متغیرها بر اساس انتقال و محتوای پیام JSON و XML را نشان می‌دهد. | اختصاص پیام متغیرهای استخراج‌شده XMLToJSON | به حداقل رساندن.js |
| xmltojson | داده‌های پاسخ را از XML به JSON تبدیل می‌کند. | XMLToJSON JSONToXML | هیچ کدام |
| فایل‌های طرحواره XML که می‌توانید هنگام پیکربندی پروکسی‌های API، سیاست‌ها، محصولات API و پروفایل‌های توسعه‌دهنده و برنامه، به عنوان مرجع از آنها استفاده کنید. | ||
| شامل یک ابزار استقرار، deploy.py، است که یک پروکسی API را به سازمانی در Apigee Edge وارد می‌کند و سپس آن را در محیط مشخص شده مستقر می‌کند. | ||
| ابزار snapshot سازمان، تنظیمات سازمان، از جمله توسعه‌دهندگان، محصولات API، میزبان‌های مجازی، نقشه‌های کلید/مقدار و غیره را بازیابی می‌کند. می‌توان از آن برای پشتیبان‌گیری از جزئیات یک سازمان یا کشف تنظیمات در یک سازمان استفاده کرد. |
آپیجی-۱۲۷
اگر کدنویس هستید، Apigee-127 به شما کمک می‌کند تا با Node.js و Swagger، پروکسی‌های API را کدنویسی کنید. همچنین می‌توانید نمونه‌های a127 را در GitHub پیدا کنید: https://github.com/apigee-127/a127-samples .
تجربه خود را به اشتراک بگذارید
تجربیات خود را در انجمن توسعه‌دهندگان Apigee به اشتراک بگذارید.