استخدام وحدة وصول واجهة برمجة التطبيقات

يتم الآن عرض مستندات Apigee Edge.
انتقِل إلى مستندات Apigee X.
المعلومات

تتيح لك الوحدة apigee-access الوصول إلى متغيّرات تدفق الخادم الوكيل لواجهة برمجة التطبيقات وذاكرات التخزين المؤقت من رمز تطبيق Node.js. يتم تضمين الوحدة مع نظام Apigee Edge الأساسي، ولن تحتاج إلى تثبيتها كما تفعل مع وحدات Node.js الأخرى.

الحصول على إذن بالوصول إلى واجهة برمجة التطبيقات

تم دمج الوحدة "apigee-access" في منصة Apigee Edge. عندما تنشر رمز Node.js على Edge، تكون هذه الوحدة متاحة لك. وما عليك سوى طلبها في أي رمز Node.js تنشره. مثال:

var access=require('apigee-access');

الوصول إلى متغيّرات التدفق

عند نشر تطبيق Node.js على Edge، يمكنك الوصول إلى أي من متغيّرات التدفق "خارج الصندوق" المتاحة، ومتغيّرات التدفق التي أنشأتها النُهج، وأي متغيّرات تدفق تنشئها بنفسك من داخل رمز Node.js. يتم إنشاء متغيّرات التدفق وتكون متوفّرة في سياق الخادم الوكيل لواجهة برمجة التطبيقات الذي يعمل على Edge. للحصول على معلومات مفصّلة، راجِع الوصول إلى متغيّرات التدفق في Node.js.

الوصول إلى ذاكرة التخزين المؤقت

تتيح لك الوحدة apigee-access الوصول إلى ذاكرة التخزين المؤقت الموزَّعة في Apigee Edge من رمز Node.js. للحصول على معلومات تفصيلية، راجع الوصول إلى ذاكرة التخزين المؤقت في Node.js.

استخدام خدمة الحصة

تتيح لك الوحدة apigee-access الوصول إلى خدمة حصة Apigee Edge من رمز Node.js. للحصول على معلومات تفصيلية، راجِع الوصول إلى خدمة الحصة في Node.js.

الوصول إلى خرائط القيم الرئيسية

تتيح لك الوحدة apigee-access الوصول إلى خرائط قيم مفتاح Apigee Edge (KVMs) من رمز Node.js. للحصول على معلومات مفصّلة، راجِع الوصول إلى خرائط القيم الرئيسية في Node.js.

التشغيل في الوضع المحلي مقارنةً بالوضع المنشور

لإتاحة التطوير والاختبار على الجهاز، تعمل وحدة apigee-access في الوضع المحلي بدون اعتمادية على Apigee Edge، ولكن عند استخدام الوحدة مع خادم وكيل لواجهة برمجة التطبيقات تم نشره على Edge، يتم استبدال الوظيفة "المحلية" بوظيفة Edge الأصلية. على سبيل المثال، يمكن الوصول إلى تكملة متغيّرات التدفق الكامل في وضع النشر، في حين لا تتوفّر سوى مجموعة فرعية صغيرة عند تشغيل تطبيق Node.js على الجهاز. للحصول على قائمة بهذه متغيرات الوضع المحلي، يمكنك الاطّلاع على التشغيل في الوضع المحلي.

تحديد الوضع الذي يتم تشغيل الوحدة فيه

لتحديد الوضع الذي تستخدمه للوصول إلى apigee:

var access = require('apigee-access')
console.log('The deployment mode is ' + access.getMode());

توضّح لك القيمة المعروضة في getMode() ما إذا كان قد تم نشر تطبيق Node.js في Apigee Edge أو يتم تشغيله في الوضع المستقل. تُرجع الطريقة إحدى نتيجتَي السلسلتَين التاليتَين:

  • apigee - يعمل تطبيق Node.js على Apigee Edge وجميع الوظائف متوافقة.
  • standalone - يعمل تطبيق Node.js خارج بيئة Apigee Edge، ويتم تطبيق الوظيفة التلقائية الموضحة أعلى المستند.

التشغيل في وضع النشر

وعند نشرها على Edge، يمكن لمتصفِّح apigee-access رؤية المتغيّرات التي تم ضبطها من خلال السياسات، أما المتغيّرات التي تتم إضافتها أو تعديلها من خلال طُرق هذه الوحدة، فهي مرئية للسياسات اللاحقة في مسار الخادم الوكيل.

يمكنك العثور على رابط المتغيّرات المتوافقة في مرجع المتغيّرات. ستظهر هذه المتغيّرات وأي متغيرات يتم إنشاؤها باستخدام أسمائك الخاصة لـ apigee-access. يُرجى العلم بأنّ بعض المتغيّرات للقراءة فقط. ويتم تحديدها في مرجع المتغيّرات.

التشغيل في الوضع المحلي

في "الوضع المحلي"، يتم تشغيل رمز Node.js خارج سياق Apigee Edge. في هذا الوضع، لا يمكن الوصول إلى معظم متغيّرات التدفق المحدّدة مسبقًا ضمن رمز Node.js. يعرض هذا الجدول المجموعة الفرعية الصغيرة من متغيّرات التدفق المتاحة. ويتم دعم هذه المتغيّرات هنا من أجل دعم التطوير المحلي واختبار تطبيقات Node.js لـ Apigee Edge.

المتغيّر للقراءة فقط النوع Notes
client.received.start.time نعم سلسلة الوقت الذي تم فيه استلام الطلب
client.received.end.time نعم سلسلة الوقت الذي تم فيه استلام الطلب
client.received.start.timestamp نعم عدد صحيح الوقت الذي تم فيه استلام الطلب
client.received.end.timestamp نعم عدد صحيح الوقت الذي تم فيه استلام الطلب

ومرة أخرى، يدعم النظام الأساسي Apigee Edge مجموعة أكبر بكثير من المتغيرات المحددة مسبقًا. يمكنك الرجوع إلى مرجع المتغيرات في Apigee Edge للاطّلاع على القائمة الكاملة.