درحال مشاهده اسناد Apigee Edge هستید.
به
اسناد Apigee X بروید. اطلاعات
نمونه‌های Apigee Edge API شامل پراکسی‌های نمونه API، خط‌مشی‌ها، کد، و ابزارهایی است که قابلیت‌های Apigee Edge API Services را که در زیر توضیح داده شده است نشان می‌دهد.
برای دستورالعمل‌های استفاده از نمونه‌ها، به استفاده از پراکسی‌های میانای برنامه‌سازی کاربردی نمونه مراجعه کنید.
یادگیری ازطریق انجام دادن
می‌خواهید سریع دست به‌کار شوید و پایه‌ای محکم برای دانش خود درباره Apigee Edge بسازید؟ ما در GitHub کتابخانه‌ای از نمونه‌های «یادگیری لبه» داریم که به شما امکان می‌دهد برخی‌از پراکسی‌های نمونه را به‌سرعت مستقر، فراخوانی، و ردیابی کنید، از ساده‌ترین پراکسی شروع کنید و به پراکسی‌هایی برسید که اعتبارسنجی کلید API، سهمیه، ذخیره کردن پاسخ در حافظه نهان، مدیریت خطا، و موارد دیگر را نشان می‌دهند.
پس‌از شبیه‌سازی مخزن و راه‌اندازی محیط (که فقط چند دقیقه طول می‌کشد)، می‌توانید هر نمونه را در کمتر از یک دقیقه امتحان کنید. و ازآنجایی‌که هر نمونه یک نسخه اصلاح‌شده جدید از همان پراکسی ایجاد می‌کند، محیط شما با تعداد زیادی نمونه به‌هم‌ریخته نخواهد شد. هرزمان بخواهید می‌توانید نسخه‌های بازبینی را عوض کنید، نسخه بازبینی دیگری را در واسط کاربر مدیریت مجدد مستقر کنید، و کد پراکسی را ببینید. فایل readme هر نمونه همچنین خلاصه‌ای از عملکرد نمونه و نحوه تنظیم آن ارائه می‌دهد.
امتحان کنید! https://github.com/apigee/api-platform-samples/tree/master/learn-edge
نمونه‌های کتاب آشپزی سند
مجموعه‌ای از نمونه‌ها برای موضوعات کتابچه دستورالعمل‌های پراکسی API ارائه شده است.
| نام | شرح | انواع خط‌مشی | منابع |
|---|---|---|---|
| javascript-cookbook | تکه ساده‌ای از کد جاوا اسکریپت را نشان می‌دهد که سرایندهای HTTP را از متغیرها اضافه می‌کند، گزارش آب‌وهوای با قالب XML را از JSON به XML تبدیل می‌کند، و محتوا را برای کاربران تلفن همراه کوتاه می‌کند. | minimize.js setHeaders.js |
|
| javascript-mashup-cookbook | برنامه کامل جاوااسکریپت که میاناهای برنامه‌سازی کاربردی عمومی را فرا می‌خواند، نتایج را ترکیب می‌کند، و پاسخ غنی‌شده‌ای برای برنامه کارخواه تولید می‌کند. (توجه: این پراکسی میانای برنامه‌سازی کاربردی همان کارکرد را به‌عنوان ترکیب خط‌مشی پیاده‌سازی می‌کند و نشان می‌دهد که همان مشکل را می‌توان بااستفاده از تکنیک‌های مختلف برطرف کرد.) | Javascript | MashItUp.js |
| java-hello | نداپرز ساده «سلام دنیا» در جاوا. | JavaCallout | JavaHello.java |
| java-cookbook | محتوا و سرایندهای پاسخ را به حروف بزرگ تبدیل می‌کند. | JavaCallout |
ResponseUppercase.java |
| java-properties | نحوه استفاده از دارایی‌ها در یک تماس بیرونی جاوا را نشان می‌دهد. | JavaCallout | JavaProperties.java |
| java-error | الگوهای مدیریت خطا را که می‌توانید در کد «تماس با Java» استفاده کنید نشان می‌دهد. | JavaCallout | JavaError.java |
| policy-mashup-cookbook | برنامه کاملی که از ترکیب خط‌مشی برای فراخوانی دو میانای برنامه‌سازی کاربردی عمومی استفاده می‌کند، نتایج را ترکیب می‌کند، و پاسخ غنی‌شده‌ای برای برنامه کارخواه تولید می‌کند. (توجه: این پراکسی میانای برنامه‌سازی کاربردی همان کارکرد mashup جاوااسکریپت را پیاده‌سازی می‌کند و نشان می‌دهد که مشکل یکسانی را می‌توان بااستفاده از تکنیک‌های مختلف برطرف کرد.) | AssignMessage ServiceCallout ExtractVariables Javascript XMLToJSON |
GenerateResponse.js |
پراکسی‌های نمونه میانای برنامه‌سازی کاربردی
کارگزاران API زیر در GitHub قرار دارند، جایی که صفحات readme توضیحات مفصلی از نمونه‌ها ارائه می‌دهند. اگر به نحوه عملکرد یک خط‌مشی خاص در یک نمونه علاقه‌مند هستید، در ستون «انواع خط‌مشی» در زیر، خط‌مشی موردنظر خود را پیدا کنید، سپس روی نام نمونه در ستون «نام» کلیک کنید. (خط‌مشی‌ها به صفحات مرجع مربوطه در اسناد پیوند داده شده‌اند.)
مرجع و ابزارها
علاوه‌بر نمونه‌های دستورالعمل مستندات و پراکسی‌های نمونه در جدول‌های بالا، نمونه‌های Edge GitHub نیز حاوی این منابع است:
| نام | شرح | انواع خط‌مشی | منابع |
|---|---|---|---|
| regex-protection | خط‌مشی محافظت دربرابر تهدید عبارت باقاعده می‌تواند از APIهای زیرینه و ریزسرویس‌های شما دربرابر حمله‌های تزریق SQL محافظت کند. | موجود نیست | |
| oauth-validate-key-secret | درحال پیاده‌سازی جریان نوع اعطای گذرواژه OAuth هستید. پیش‌از فراخوانی «ارائه‌دهنده هویت» خارجی برای درستی‌سنجی اطلاعات اعتباری کاربر، باید هم کلید و هم رمز مشتری برنامه را در Edge درستی‌سنجی کنید. | OAuthV2، دیگران | موجود نیست |
| condition-pattern-matching | این پراکسی به شما امکان می‌دهد به‌راحتی گزاره‌های شرطی را در جریان پراکسی API امتحان و آزمایش کنید. | AssignMessage | موجود نیست |
| access-entity | نحوه بازیابی نمایه‌های نهادها از مخزن داده Apigee Edge را نشان می‌دهد. | AssignMessage AccessEntity ExtractVariables |
هیچ‌کدام |
| apikey | اعتبارسنجی ساده کلید میانای برنامه‌سازی کاربردی را پیاده‌سازی می‌کند | VerifyAPIKey AssignMessage Quota |
هیچ‌کدام |
| async-callout | یک پیام‌واره ناهم‌زمان ساده را بااستفاده از httpClient جاوا اسکریپت نشان می‌دهد. | Javascript | assemble_response.js callout.js |
| base64encoder | نحوه فراخوانی شامل‌های جاوا اسکریپت از منابع جاوا اسکریپت در پراکسی‌های API را نشان می‌دهد. | AssignMessage جاوا اسکریپت |
core-min.js enc-utf16-min.js enc-base64-min.js encodeAuthHeader.js |
| conditional-policy | اجرای خط‌مشی شرطی ساده را پیاده‌سازی می‌کند. وقتی درخواستی حاوی سرایند HTTP responsetime:true باشد، خط‌مشی‌ای یک نوشتار Python را اجرا می‌کند که مجموعه‌ای از سنجه‌های عملکرد را به‌عنوان سرایندهای HTTP به پیام پاسخ اضافه می‌کند | متن (Python) | timer.py |
| dynamic-endpoint | در سناریویی کمی پیچیده‌تر، مسیریابی شرطی ساده‌ای را پیاده‌سازی می‌کند که دو نشانی وب و یک مسیر پیش‌فرض را تعریف می‌کند. | هیچ‌کدام | هیچ‌کدام |
| jira-release-notes | این کارگزار API است که تیم اسناد Apigee برای تولید یادداشت‌های انتشار از Jira استفاده می‌کند. | JSONToXML XSL |
releasenotes_api.xsl |
| kerberos-credential-mediation | این نمونه نشان می‌دهد چگونه «واسطه‌گری اطلاعات اعتباری Kerberos» را در Apigee Edge انجام دهید. | JavaCallout | فایل Java JAR |
| oauth-advanced | نمونه کامل و کارآمدی از جریان نوع اعطای کد مجوز، با Apigee Edge به‌عنوان سرور مجوز. |
GenerateAccessToken بسیاری دیگر… |
دیدن کد نمونه |
| oauth-client-credentials | نقطه پایان کد OAuth 2.0 کاملاً کاربردی را که برای نوع اعطای اعتبارنامه‌های کارخواه پیکربندی شده است نشان می‌دهد. | GenerateAccessToken | هیچ‌کدام |
| oauth-login-app | منسوخ‌شده. توصیه می‌کنیم به‌جای آن به نمونه oauth-advanced نگاه کنید. | ||
| oauth-validate-key-secret | تکنیکی را برای اعتبارسنجی کلید و رمز مشتری قبل‌از فراخوانی ارائه‌دهنده هویت برای اعتبارسنجی اطلاعات کاربری کاربر در جریان نوع اعطای گذرواژه نشان می‌دهد. | OAuthV2 AssignMessage ExtractVariables ServiceCallout RaiseFault |
هیچ‌کدام |
| oauth-verify-accesstoken | پراکسی میانای برنامه‌سازی کاربردی را نشان می‌دهد که برای اعتبارسنجی کدهای دسترسی OAuth 2.0 و تأیید سهمیه پیکربندی شده است. | VerifyAccessToken Quota |
هیچ‌کدام |
| oauth10a-3legged | پیکربندی سه‌پایه OAuth 1.0a را نشان می‌دهد. | GenerateAccessToken GenerateRequestToken ServiceCallout VerifyAccessToken |
هیچ‌کدام |
| outbound-oauth | از Microsoft Azure translator API برای ترجمه کردن توییت‌ها استفاده می‌کند. برای انجام این کار، تماس خروجی برقرار می‌کند تا «رمز دسترسی OAuth» را دریافت کند، و سپس بااستفاده از خط‌مشی‌های ذخیره کردن در حافظه نهان «خدمات API»، رمز را در حافظه نهان ذخیره می‌کند و هر بار که تماس خروجی برقرار می‌شود از رمز ذخیره‌شده در حافظه نهان استفاده می‌کند. همچنین شامل برنامه مرورگر نمایشی است که برای فراخوانی پراکسی API استفاده می‌شود. | AssignMessage LookupCache PopulateCache Javascript |
api-config.js api-token-get.js translate-query.js translate-results.js |
| صفحه‌بندی | پیام پاسخ XML را براساس پارامترهای محدودیت و جابه‌جایی ارائه‌شده توسط کارخواه صفحه‌بندی می‌کند | AssignMessage ExtractVariables ResponseCache VerifyApiKey XSL |
paginate.xslt |
| response-cache | نحوه ذخیره کردن پیش‌بینی‌های آب‌وهوا در حافظه نهان Edge به‌مدت ۱۰ دقیقه را نشان می‌دهد. | ResponseCache AssignMessage |
هیچ‌کدام |
| simple-python | سناریو ساده‌ای از پیوست کردن یک دستورگان پایتون در پاسخ را نشان می‌دهد که مقدار سرایندی را به آن اضافه می‌کند. |
متن (Python) | setHeader.py |
| soap | تبدیل XSL را نشان می‌دهد که فایل WSDL را در پاسخ به درخواست با پارامتر پُرسمان ?wsdl بازنویسی می‌کند. | AssignMessage ExtractVariables Script (Python) XSL |
calculateaddress.py fixwsdl.xsl |
| جاری‌سازی | پیکربندی جاری‌سازی HTTP را نشان می‌دهد. | هیچ‌کدام | هیچ‌کدام |
| target-reroute | نشان می‌دهد که چگونه از جاوا اسکریپت برای انتخاب پویا نشانی وب مقصد براساس محتوای پیام درخواست استفاده کنید. | ExtractVariables جاوا اسکریپت |
rewriteTargetUrl.js |
| twitter-mobile-timeline | نحوه استفاده از جاوا اسکریپت برای حذف پارامترهای غیرضروری از توییت‌ها را نشان می‌دهد، که منجر به یک خط زمان Twitter ساده‌شده می‌شود که برای دستگاه‌های همراه با منابع محدود دوستانه است. | AssignMessage جاوا اسکریپت |
MobileTimeline.js |
| twitter-oembed | پاسخ‌های خط زمان (برای نمونه از statuses/user_timeline.json) را به پاسخ oEmbed تبدیل می‌کند که حاوی داده‌های خط زمان به‌عنوان محتوای HTML غنی است. | AssignMessage JavaScript |
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 هم‌رسانی کنید.