شما در حال مشاهده اسناد Apigee Edge هستید.
به مستندات Apigee X بروید . اطلاعات
نمونه‌های Apigee Edge شامل پراکسی‌های API نمونه، خط‌مشی‌ها، کد و ابزارهایی هستند که قابلیت‌های Apigee Edge API Services شرح داده شده در زیر را نشان می‌دهند.
برای دستورالعمل‌های استفاده از نمونه‌ها، به استفاده از نمونه پراکسی‌های API مراجعه کنید.
با انجام دادن یاد بگیرید
آیا می خواهید با عجله دست خود را کثیف کنید و شروع به ایجاد یک پایگاه دانش قوی در مورد Apigee Edge کنید؟ ما کتابخانه‌ای از نمونه‌های "لبه یادگیری" در GitHub داریم که به شما امکان می‌دهد به سرعت برخی از پراکسی‌های نمونه را استقرار، فراخوانی و ردیابی کنید، از ساده‌ترین پراکسی شروع کنید و به پراکسی‌هایی بروید که اعتبارسنجی کلید API، سهمیه، ذخیره پاسخ، خطا را نشان می‌دهند. جابجایی و موارد دیگر
هنگامی که مخزن را شبیه سازی کردید و محیط خود را تنظیم کردید (فقط چند دقیقه طول می کشد)، می توانید هر نمونه را در کمتر از یک دقیقه امتحان کنید. و از آنجا که هر نمونه یک ویرایش جدید از همان پروکسی ایجاد می کند، محیط شما با نمونه های زیادی شلوغ نمی شود. می‌توانید ویرایش‌ها را تغییر دهید، نسخه‌ای دیگر را در رابط کاربری مدیریت مجدداً اجرا کنید و هر زمان که بخواهید به کد پراکسی نگاه کنید. readme برای هر نمونه همچنین خلاصه‌ای از کارهایی که نمونه انجام می‌دهد و نحوه تنظیم آن به شما می‌دهد.
آن را امتحان کنید! https://github.com/apigee/api-platform-samples/tree/master/learn-edge
نمونه کتاب آشپزی Doc
مجموعه ای از نمونه ها برای موضوعات کتاب آشپزی پروکسی API ارائه شده است.
| نام | توضیحات | انواع خط مشی | منابع |
|---|---|---|---|
| جاوا اسکریپت-کتاب آشپزی | یک قطعه ساده جاوا اسکریپت را نشان می‌دهد که سرصفحه‌های HTTP را از متغیرها اضافه می‌کند، گزارش آب‌وهوای قالب‌بندی شده با XML را از JSON به XML تبدیل می‌کند و محتوا را برای مشتریان تلفن همراه کاهش می‌دهد. | minimize.js setHeaders.js | |
| javascript-mashup-cookbook | یک برنامه کامل جاوا اسکریپت که به APIهای عمومی فراخوانی می کند، نتایج را ترکیب می کند و پاسخی غنی برای برنامه مشتری ایجاد می کند. (توجه: این پراکسی API عملکردی مشابه با Policy-mashup را پیاده‌سازی می‌کند و نشان می‌دهد که مشکل مشابه را می‌توان با استفاده از تکنیک‌های مختلف برطرف کرد.) | جاوا اسکریپت | MashItUp.js |
| جاوا-سلام | فراخوانی ساده hello world Java. | JavaCallout | JavaHello.java |
| جاوا-کتاب آشپزی | محتوای پاسخ و سرصفحه ها را به حروف بزرگ تبدیل می کند. | JavaCallout | ResponseUppercase.java |
| java-properties | نحوه استفاده از ویژگی ها در فراخوانی جاوا را نشان می دهد. | JavaCallout | JavaProperties.java |
| خطای جاوا | الگوهای مدیریت خطا را نشان می دهد که می توانید در کد Java Callout استفاده کنید. | JavaCallout | JavaError.java |
| سیاست-مشاپ-کتاب آشپزی | یک برنامه کامل که از ترکیب خط مشی برای فراخوانی دو API عمومی استفاده می کند، نتایج را ترکیب می کند و یک پاسخ غنی برای برنامه مشتری ایجاد می کند. (توجه: این پروکسی API همان عملکرد جاوا اسکریپت-mashup را پیاده‌سازی می‌کند و نشان می‌دهد که با استفاده از تکنیک‌های مختلف می‌توان به همان مشکل رسیدگی کرد.) | AssignMessage ServiceCallout ExtractVariables جاوا اسکریپت XMLToJSON | GenerateResponse.js |
نمونه پروکسی های API
پراکسی های API زیر در GitHub قرار دارند، جایی که صفحات readme توضیحات دقیقی از نمونه ها ارائه می دهند. اگر به نحوه عملکرد یک خط‌مشی خاص در یک نمونه علاقه دارید، در ستون انواع خط‌مشی زیر به دنبال سیاست مورد نظر خود بگردید، سپس روی نام نمونه در ستون نام کلیک کنید. (خط مشی ها به صفحات مرجع مربوطه خود در اسناد پیوند داده شده اند.)
مرجع و ابزار
علاوه بر نمونه‌های کتاب آشپزی doc و پراکسی‌های نمونه در جداول بالا، نمونه‌های Edge GitHub نیز حاوی این منابع هستند:
| نام | توضیحات | انواع خط مشی | منابع |
|---|---|---|---|
| r egex-protection | خط مشی حفاظت از تهدید بیان منظم می تواند API های پشتیبان و میکروسرویس های شما را در برابر حملات تزریق SQL محافظت کند. | N/A | |
| oauth-validate-key-secret | شما در حال اجرای جریان نوع اعطای رمز عبور OAuth هستید. قبل از تماس با یک Identity Provider خارجی برای تأیید اعتبار کاربر، باید هم کلید مشتری برنامه و هم راز را در Edge تأیید کنید. | OAuthV2 ، دیگران | N/A |
| شرط-الگو-تطابق | این پروکسی به شما امکان می دهد به راحتی عبارات شرطی را در یک جریان پروکسی API امتحان و آزمایش کنید. | AssignMessage | N/A |
| موجودیت دسترسی | نحوه بازیابی نمایه‌های موجودیت‌ها از فروشگاه داده Apigee Edge را نشان می‌دهد. | AssignMessage AccessEntity ExtractVariables | هیچ کدام |
| apikey | اعتبار سنجی کلید API ساده را پیاده سازی می کند | VerifyAPIKey AssignMessage سهمیه | هیچ کدام |
| ناهمگام فراخوانی | با استفاده از JavaScript httpClient یک فراخوان ناهمزمان ساده را نشان می دهد. | جاوا اسکریپت | assemble_response.js callout.js |
| رمزگذار base64 | نحوه فراخوانی جاوا اسکریپت شامل منابع جاوا اسکریپت در پراکسی های API را نشان می دهد. | AssignMessage جاوا اسکریپت | core-min.js enc-utf16-min.js enc-base64-min.js encodeAuthHeader.js |
| مشروط-سیاست | اجرای سیاست مشروط ساده را اجرا می کند. هنگامی که یک درخواست حاوی یک HTTP header answertime:true است، یک خط مشی یک اسکریپت پایتون را اجرا می کند که مجموعه ای از معیارهای عملکرد را به عنوان سرصفحه های HTTP به پیام پاسخ اضافه می کند. | اسکریپت (پایتون) | timer.py |
| نقطه پایان پویا | مسیریابی ساده شرطی را در سناریوی کمی پیچیده‌تر پیاده‌سازی می‌کند که دو URL و یک مسیر پیش‌فرض را تعریف می‌کند. | هیچ کدام | هیچ کدام |
| jira-release-notes | این پروکسی API است که توسط تیم سند Apigee برای ایجاد یادداشت‌های انتشار از Jira استفاده می‌شود. | JSONToXML XSL | releasenotes_api.xsl |
| kerberos-credential-mediation | این نمونه نحوه اجرای Kerberos Credential Mediation در Apigee Edge را نشان می دهد. | JavaCallout | فایل جاوا JAR |
| oauth-پیشرفته | یک نمونه کامل و کارآمد از جریان نوع اعطای کد مجوز، با Apigee Edge به عنوان سرور مجوز. | GenerateAccessToken بسیاری دیگر... | کد نمونه را ببینید |
| oauth-client-credentials | یک نقطه پایانی رمز OAuth 2.0 کاملاً کاربردی را نشان می دهد که برای نوع اعطای اعتبارنامه مشتری پیکربندی شده است. | GenerateAccessToken | هیچ کدام |
| oauth-login-app | منسوخ شده است. توصیه می کنیم به جای آن به نمونه پیشرفته oauth نگاه کنید. | ||
| oauth-validate-key-secret | تکنیکی را برای اعتبارسنجی کلید و راز مشتری قبل از تماس با ارائه‌دهنده هویت برای تأیید اعتبار کاربر در جریان نوع اعطای رمز عبور نشان می‌دهد. | OAuthV2 AssignMessage ExtractVariables ServiceCallout Raise Fault | هیچ کدام |
| oauth-verify-accesstoken | یک پروکسی API را نشان می دهد که برای تأیید اعتبار نشانه های دسترسی OAuth 2.0 و تأیید سهمیه پیکربندی شده است. | VerifyAccessToken سهمیه | هیچ کدام |
| oauth10a-3legged | یک پیکربندی سه پایه OAuth 1.0a را نشان می دهد. | GenerateAceessToken GenerateRequestToken ServiceCallout VerifyAccessToken | هیچ کدام |
| برون مرزی | از API مترجم Microsoft Azure برای ترجمه توییت ها استفاده می کند. برای انجام این کار، یک تماس خروجی برای به دست آوردن یک نشانه دسترسی OAuth برقرار می کند، و سپس با استفاده از خط مشی های ذخیره سازی API Services، رمز را در حافظه پنهان ذخیره می کند و هر بار که تماس خروجی برقرار می شود، رمز ذخیره شده را مجدداً استفاده می کند. همچنین، شامل یک برنامه مرورگر نمایشی است که برای فراخوانی پروکسی API استفاده می شود. | AssignMessage LookupCache PopulateCache جاوا اسکریپت | api-config.js api-token-get.js translate-query.js translate-results.js |
| صفحه بندی | یک پیام پاسخ XML را بر اساس پارامترهای محدود و افست ارائه شده توسط مشتری صفحه بندی می کند | AssignMessage ExtractVariables ResponseCache VerifyApiKey XSL | paginate.xslt |
| پاسخ-کش | نشان می دهد که چگونه پیش بینی های آب و هوا را در Edge به مدت 10 دقیقه ذخیره کنید. | ResponseCache AssignMessage | هیچ کدام |
| ساده-پایتون | یک سناریوی ساده از پیوست کردن یک اسکریپت پایتون را نشان می دهد پاسخی که یک مقدار هدر به آن اضافه می کند. | اسکریپت (پایتون) | setHeader.py |
| صابون | یک تبدیل XSL را نشان می دهد که یک فایل WSDL را در پاسخ به درخواستی با پارامتر پرس و جو ?wsdl بازنویسی می کند. | AssignMessage ExtractVariables اسکریپت (پایتون) XSL | accountaddress.py fixwsdl.xsl |
| جریان | پیکربندی جریان HTTP را نشان می دهد. | هیچ کدام | هیچ کدام |
| هدف - تغییر مسیر | با استفاده از جاوا اسکریپت برای انتخاب پویا یک URL هدف بر اساس محتوای یک پیام درخواست را نشان می دهد. | ExtractVariables جاوا اسکریپت | rewriteTargetUrl.js |
| twitter-mobile-timeline | نحوه استفاده از جاوا اسکریپت را برای حذف پارامترهای غیر ضروری از توییت‌ها نشان می‌دهد که منجر به ایجاد یک جدول زمانی ساده توییتر می‌شود که برای دستگاه‌های تلفن همراه با محدودیت منابع مناسب است. | AssignMessage جاوا اسکریپت | MobileTimeline.js |
| twitter-embed | پاسخ‌های جدول زمانی (مثلاً از statuses/user_timeline.json) را به یک پاسخ oEmbed تبدیل می‌کند که حاوی داده‌های جدول زمانی به عنوان محتوای غنی HTML است. | AssignMessage جاوا اسکریپت | search-oembed.js |
| متغیرها | نحوه استخراج و تنظیم متغیرها بر اساس انتقال و محتوای پیام JSON و XML را نشان می دهد. | AssignMessage ExtractVariables XMLToJSON | minimize.js |
| xmltojson | داده های پاسخ را از XML به JSON تبدیل می کند. | XMLToJSON JSONToXML | هیچ کدام |
| فایل‌های طرحواره XML که می‌توانید هنگام پیکربندی پراکسی‌های API، خط‌مشی‌ها، محصولات API و نمایه‌های برنامه‌نویس و برنامه از آنها به عنوان مرجع استفاده کنید. | ||
| حاوی یک ابزار استقرار به نام deploy.py است که یک پروکسی API را به سازمانی در Apigee Edge وارد کرده و سپس آن را در محیط مشخص شده مستقر می کند. | ||
| ابزار عکس فوری سازمان تنظیمات سازمان، از جمله توسعه دهندگان، محصولات API، میزبان های مجازی، نقشه های کلید/مقدار و غیره را بازیابی می کند. می توان از آن برای تهیه نسخه پشتیبان از جزئیات یک سازمان یا کشف تنظیمات در یک سازمان استفاده کرد. |
Apigee-127
اگر کدنویس هستید، Apigee-127 شما را راهنمایی می‌کند و با Node.js و Swagger پروکسی‌های API را کدنویسی می‌کند. همچنین می‌توانید نمونه‌های a127 را در GitHub پیدا کنید: https://github.com/apigee-127/a127-samples .
تجربه خود را به اشتراک بگذارید
تجربیات خود را در انجمن توسعه دهندگان Apigee به اشتراک بگذارید.