أنت تطّلع على مستندات Apigee Edge.
انتقِل إلى
مستندات Apigee X. info
تحتوي عيّنات واجهة برمجة التطبيقات Apigee Edge على عيّنات من الأدوات والسياسات والرموز البرمجية والخوادم الوكيلة لواجهات برمجة التطبيقات التي توضّح إمكانات خدمات واجهة برمجة التطبيقات Apigee Edge الموضّحة أدناه.
للحصول على تعليمات حول استخدام العيّنات، يُرجى الاطّلاع على استخدام نماذج الخوادم الوكيلة لواجهات برمجة التطبيقات.
التعلم من خلال الممارسة
هل تريد البدء في إنشاء قاعدة معرفة قوية عن Apigee Edge؟ لدينا مكتبة من نماذج "التعلم المتقدم" في GitHub تتيح لك نشر بعض نماذج الخوادم الوكيلة واستدعائها وتتبُّعها بسرعة، بدءًا من أبسط خادم وكيل وانتهاءً بالخوادم الوكيلة التي توضّح عملية التحقّق من مفتاح واجهة برمجة التطبيقات والحصة وتخزين الاستجابة المؤقت ومعالجة الأخطاء وغير ذلك.
بعد استنساخ المستودع وإعداد بيئتك (تستغرق العملية بضع دقائق فقط)، يمكنك تجربة كل عيّنة في أقل من دقيقة. ولأنّ كل عيّنة تنشئ مراجعة جديدة للوكيل نفسه، لن تصبح بيئتك مزدحمة بالكثير من العيّنات. يمكنك تبديل النُسخ وإعادة نشر نسخة مختلفة في واجهة مستخدِم الإدارة والاطّلاع على رمز الوكيل في أي وقت. يوفّر لك ملف Readme لكل عيّنة أيضًا ملخّصًا موجزًا عن الغرض من العيّنة وكيفية إعدادها.
ننصحك بتجربة ذلك. https://github.com/apigee/api-platform-samples/tree/master/learn-edge
نماذج كتب طبخ في "مستندات Google"
يتمّ تقديم مجموعة من العيّنات لمواضيع كتاب الطبخ الخاص ببرنامج "الوكيل لواجهة برمجة التطبيقات".
| الاسم | الوصف | أنواع السياسة | الموارد |
|---|---|---|---|
| javascript-cookbook | يعرض مقتطفًا بسيطًا من JavaScript يضيف رؤوس HTTP من المتغيّرات، ويحوّل تقرير الطقس بتنسيق XML من JSON إلى XML، ويقطع المحتوى لعملاء الأجهزة الجوّالة. | minimize.js setHeaders.js |
|
| javascript-mashup-cookbook | تطبيق JavaScript كامل يستدعي واجهات برمجة التطبيقات العامة ويجمع النتائج ويُنشئ بدوره ردًا مفصّلاً لتطبيق العميل (ملاحظة: ينفِّذ وكيل واجهة برمجة التطبيقات هذا الوظائف نفسها التي يؤديها أسلوب دمج السياسات، ما يشير إلى أنّه يمكن معالجة المشكلة نفسها باستخدام أساليب مختلفة). | Javascript | MashItUp.js |
| java-hello | وسيلة شرح بسيطة لبرنامج Hello World في Java | JavaCallout | JavaHello.java |
| java-cookbook | لتحويل محتوى الردّ والعناوين إلى أحرف كبيرة | JavaCallout |
ResponseUppercase.java |
| java-properties | توضِّح كيفية استخدام السمات في تعليق توضيحي لبرنامج Java. | JavaCallout | JavaProperties.java |
| java-error | يوضِّح أنماط معالجة الأخطاء التي يمكنك استخدامها في رمز Java Callout. | JavaCallout | JavaError.java |
| policy-mashup-cookbook | تطبيق كامل يستخدم تركيب السياسة للاتّصال بواجهتَي برمجة تطبيقات عامتَين، ويجمع النتائج، وينشئ استجابة مفصّلة لتطبيق العميل. (ملاحظة: يوفّر وكيل واجهة برمجة التطبيقات الوظيفة نفسها التي يوفّرها أسلوب دمج JavaScript، ما يشير إلى أنّه يمكن معالجة المشكلة نفسها باستخدام أساليب مختلفة). | AssignMessage ServiceCallout ExtractVariables Javascript XMLToJSON |
GenerateResponse.js |
نماذج للوكلاء لواجهة برمجة التطبيقات
يمكن العثور على أدوات الربط التالية لواجهات برمجة التطبيقات في GitHub، حيث توفّر صفحات readme أوصافًا تفصيلية للعينات. إذا كنت مهتمًا بمعرفة كيفية عمل سياسة معيّنة في عيّنة، ابحث في عمود "أنواع السياسات" أدناه عن السياسة التي تهمّك، ثم انقر على اسم العيّنة في عمود "الاسم". (يتم ربط السياسات بصفحات المرجع ذات الصلة في المستندات).
المراجع والأدوات
بالإضافة إلى نماذج دليل إعداد ملفات البيانات ونماذج الخوادم الوكيلة في الجداول أعلاه، تحتوي عيّنات GitHub في Edge أيضًا على موارد التالية:
| الاسم | الوصف | أنواع السياسة | الموارد |
|---|---|---|---|
| regex-protection | يمكن أن تحمي سياسة الحماية من التهديدات المستندة إلى التعبيرات العادية واجهات برمجة التطبيقات و الخدمات المصغرة في الخلفية من هجمات حقن SQL. | لا ينطبق | |
| oauth-validate-key-secret | أنت بصدد تنفيذ مسار نوع منح كلمة المرور في OAuth. عليك التحقّق من صحة كلٍّ من مفتاح عميل التطبيق وسرّه على Edge قبل الاتصال بموفِّر هوية خارجي للتحقّق من صحة بيانات اعتماد المستخدم. | OAuthV2، وغيرها | لا ينطبق |
| condition-pattern-matching | يتيح لك هذا الوكيل تجربة الجمل الشَرطية واختبارها بسهولة في مسار وكيل واجهة برمجة التطبيقات. | AssignMessage | لا ينطبق |
| access-entity | توضِّح كيفية استرداد الملفات الشخصية للكيانات من مستودع بيانات Apigee Edge. | AssignMessage AccessEntity ExtractVariables |
لا ينطبق |
| apikey | تنفيذ عملية التحقّق البسيطة من مفتاح واجهة برمجة التطبيقات | VerifyAPIKey AssignMessage Quota |
لا ينطبق |
| async-callout | يوضّح هذا القسم طلبًا بسيطًا غير متزامن باستخدام httpClient في JavaScript. | Javascript | assemble_response.js callout.js |
| base64encoder | توضِّح كيفية استدعاء عمليات تضمين JavaScript من موارد JavaScript في وكيل واجهة برمجة التطبيقات. | AssignMessage JavaScript |
core-min.js enc-utf16-min.js enc-base64-min.js encodeAuthHeader.js |
| conditional-policy | تنفيذ فرض سياسة مشروطة بسيطة عندما يحتوي الطلب على عنوان HTTP responsetime:true، تنفِّذ السياسة نصًا برمجيًا بلغة Python يضيف مجموعة من مقاييس الأداء إلى رسالة الاستجابة، بصفتها عناوين HTTP. | Script (Python) | timer.py |
| dynamic-endpoint | تنفيذ توجيه شَرطي بسيط في سيناريو أكثر تعقيدًا قليلاً، والذي يحدِّد عنوانَي URL ومسارًا تلقائيًا واحدًا | لا ينطبق | لا ينطبق |
| jira-release-notes | هذا هو الوكيل لواجهة برمجة التطبيقات الذي يستخدمه فريق مستندات Apigee لإنشاء ملاحظات الإصدار من Jira. | JSONToXML XSL |
releasenotes_api.xsl |
| kerberos-credential-mediation | يوضّح هذا المثال كيفية تنفيذ التوسّط في بيانات اعتماد Kerberos على Apigee Edge. | JavaCallout | ملف JAR في Java |
| 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 الثلاثي. | GenerateAceessToken GenerateRequestToken ServiceCallout VerifyAccessToken |
لا ينطبق |
| outbound-oauth | يستخدم Microsoft Azure Translator API لترجمة التغريدات. ولإجراء ذلك، يُجري التطبيق مكالمة خارجية للحصول على رمز مميّز للوصول عبر بروتوكول OAuth، ثم يخزّن الرمز المميّز باستخدام سياسات ميزة "تخزين مؤقت" في "خدمات واجهة برمجة التطبيقات"، مع إعادة استخدام الرمز المميّز المخزّن مؤقتًا في كل مرة يتم فيها إجراء مكالمة خارجية. يتضمّن أيضًا تطبيق متصفح توضيحيًا يُستخدَم لطلب الخادم الوكيل لواجهة برمجة التطبيقات. | 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 لمدة 10 دقائق. | ResponseCache AssignMessage |
لا ينطبق |
| simple-python | يوضّح هذا السيناريو البسيط عملية إرفاق نص برمجي بلغة Python في الاستجابة التي تضيف قيمة عنوان إليه. |
Script (Python) | setHeader.py |
| صابون | توضِّح هذه الصفحة عملية تحويل XSL التي تعيد كتابة ملف WSDL استجابةً لطلب باستخدام مَعلمة الطلب ?wsdl. | AssignMessage ExtractVariables Script (Python) XSL |
calculateaddress.py fixwsdl.xsl |
| البث | توضِّح هذه المقالة إعدادات البث عبر HTTP. | لا ينطبق | لا ينطبق |
| target-reroute | يوضّح استخدام JavaScript لاختيار عنوان URL مستهدَف ديناميكيًا استنادًا إلى محتوى رسالة الطلب. | ExtractVariables JavaScript |
rewriteTargetUrl.js |
| twitter-mobile-timeline | توضِّح كيفية استخدام JavaScript لإزالة المَعلمات غير المطلوبة من التغريدات، مما يؤدي إلى إنشاء مخطط زمني سلس على Twitter يناسب الأجهزة الجوّالة التي تواجه قيودًا في الموارد. | AssignMessage JavaScript |
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 والسياسات ومنتجات واجهة برمجة التطبيقات وملفات تعريف المطوّرين والتطبيقات |
||
|
|
يحتوي على أداة نشر، وهي deploy.py، التي تستورد وكيل واجهة برمجة التطبيقات إلى مؤسسة على Apigee Edge، ثم تنشرها في البيئة المحدّدة. |
||
|
|
تسترجع أداة "لقطة المؤسسة" إعدادات المؤسسة، بما في ذلك المطوّرين، ومنتجات واجهات برمجة التطبيقات، والمضيفين الظاهريين، وعمليات ربط المفاتيح بالقيم، وما إلى ذلك. ويمكن استخدامها لإجراء نسخة احتياطية من تفاصيل المؤسسة، أو لاكتشاف الإعدادات في المؤسسة. |
Apigee-127
إذا كنت مبرمجًا، يمكنك استخدام Apigee-127 لإنشاء واجهة برمجة تطبيقات باستخدام أدوات Node.js وSwagger. يمكنك أيضًا العثور على نماذج a127 على GitHub: https://github.com/apigee-127/a127-samples.
مشاركة تجربتك
شارِك تجاربك في منتدى مطوّري Apigee.