أنت الآن بصدد الاطّلاع على مستندات Apigee Edge.
انتقِل إلى
مستندات Apigee X. info
يوضّح هذا الموضوع كيفية نشر تطبيق Node.js من نظامك المحلي إلى Apigee Edge.
في هذا الموضوع، سنتحدّث عن كيفية استخدام أداة سطر أوامر تُسمّى apigeetool لنشر تطبيقات Node.js على Apigee Edge.
لمحة عن نشر رمز Node.js على Apigee Edge
يمكنك نشر تطبيق حالي لواجهة برمجة تطبيقات Node.js، بما في ذلك أي وحدات Node.js تابعة، من نظامك المحلي إلى Apigee Edge باستخدام أداة سطر أوامر تُسمى apigeetool. تعمل الأداة المساعدة تلقائيًا على تجميع التطبيق وتبعياته
في خادم وكيل لواجهة برمجة التطبيقات ونشره على Edge.
على سبيل المثال، لنفترض أنّك استخدمت Express لإنشاء تطبيق ويب في Node.js. يعمل التطبيق كخادم HTTP يستمع إلى طلبات HTTP ويعالجها ويعرض البيانات وما إلى ذلك. عند استخدام apigeetool لتفعيل تطبيق Node.js على Edge، يتم تضمينه في خادم وكيل ويتم تنفيذه في سياق منصة Edge. يمكنك بعد ذلك استدعاء تطبيقك من خلال عنوان URL الجديد للخادم الوكيل، ويمكنك إضافة قيمة إليه من خلال "تزيينه" بميزات Edge العادية، مثل أمان OAuth وسياسات الحصص وسياسات الحماية من التهديدات والتدفقات الشرطية والتخزين المؤقت وغيرها الكثير.
ما هي وظيفة apigeetool؟
عند تشغيل الأداة المساعدة apigeetool مع الخيار deploynodeapp، سيتم تنفيذ ما يلي:
- تُنشئ هذه السمة حزمة إعدادات لخادم وكيل لواجهة برمجة التطبيقات من أجل استضافة تطبيق Node.js.
- يحزّم تطبيق Node.js مع أي حِزم Node.js مثبَّتة باستخدام NPM (وحدات Node المعبأة).
- يستورد حزمة إعدادات خادم وكيل لواجهة برمجة التطبيقات إلى المؤسسة المحدّدة على Apigee Edge باستخدام Edge Management API.
- تنشر هذه السمة خادم وكيل لواجهة برمجة التطبيقات في إحدى البيئات.
- تنفيذ تطبيق Node.js على Apigee Edge وإتاحته عبر الشبكة
الاستعداد لاستخدام apigeetool
قبل البدء، عليك تثبيت أداة apigeetool.
يمكنك تثبيت apigeetool من خلال npm أو عن طريق استنساخ الرمز وربطه من GitHub.
التثبيت من npm
تم تصميم الوحدة apigeetool والملفات التابعة لها للعمل على Node.js، وهي متاحة من خلال npm باستخدام الأمر التالي:
$ sudo npm install -g apigeetool
عادةً، يضع الخيار -g الوحدات في:
/usr/local/lib/node_modules/apigeetool على الأجهزة المستندة إلى *nix.
التثبيت من GitHub
يمكنك تنزيل "أدوات منصة واجهة برمجة التطبيقات" أو إنشاء نسخة منها من GitHub. يمكنك الاطّلاع على ملف README في الدليل الجذر للمستودع للحصول على تعليمات التثبيت.
$ git clone https://github.com/apigee/apigeetool-node.git
بعد إكمال عملية التثبيت، تأكَّد من أنّ الملف التنفيذي apigeetool موجود في مسارك. يمكنك تجربة ذلك من خلال كتابة:
$ apigeetool -h
نشر تطبيق Node.js على Edge باستخدام apigeetool
ملاحظة: قبل النشر، عليك معرفة اسم مؤسستك على Apigee Edge واسم المستخدم وكلمة المرور لحسابك على Apigee Edge. تحتاج إلى هذه المعلومات لتكوين الأمر apigeetool بشكل صحيح.
لنشر تطبيق Node.js باستخدام apigeetool، اتّبِع الخطوات التالية:
- في نافذة طرفية،
cdالدليل الجذر لتطبيق Node.js. - نفِّذ الأداة
apigeetoolباستخدام الأمرdeploynodeapp:
على سبيل المثال:$ apigeetool deploynodeapp -n {A name for your new proxy} -d {The root directory of your Node.js app} -m {The name of the main Node.js file} -o {Your org name on Edge} -e {The environment to deploy to} -b {The base URL for your proxy} -u {Your Edge email address} -p {Your Edge password}
$ apigeetool deploynodeapp -n myNodeApp -d . -m server.js -o myorg -e test -b /myNodeApp -u ntesla -p myPassword
- تحقَّق من الناتج في نافذة المحطة الطرفية. سيبدو على النحو التالي:
Importing new application myNodeApp Imported new app revision 1 Deploying revision 1 Deployed. Proxy: "myNodeApp" Revision 1 Environment: test BasePath: /myNodeApp Status: deployed
إذا ظهرت لك الحالة "تم النشر"، يعني ذلك أنّك انتهيت. سارت الأمور بسلاسة. يتم تضمين تطبيق Node.js في وكيل لواجهة برمجة التطبيقات، ويتم نشره على Edge، وهو يعمل وينتظر معالجة الطلبات. أصبحت جاهزة للاختبار.
- اختبِر الخادم الوكيل. على سبيل المثال:
$ curl http://myorg-test.apigee.net/myNodeApp Hello, My Node App!
- إذا أردت ذلك، سجِّل الدخول إلى حسابك على Apigee Edge وانتقِل إلى صفحة "خوادم وكيل واجهة برمجة التطبيقات" في واجهة مستخدم الإدارة. ستظهر لك الخادم الوكيل الجديد في تلك القائمة.
طريقة تعامل apigeetool مع الملفات والوحدات التابعة
إذا كان تطبيق Node.js يعتمد على وحدات مثبَّتة، يتعامل apigeetool معها من خلال ضغط المجلد node_modules وإضافته إلى حزمة الخادم الوكيل. وليس عليك اتخاذ أي إجراء إضافي. وينطبق الأمر نفسه على أي أدلة تحتوي على رمز مصدر إضافي. تعمل الأداة المساعدة apigeetool على ضغطها وتفعيلها مع الحزمة.
لا يمكنك تعديل الملفات في هذه الأدلة المضغوطة في محرِّر واجهة مستخدم إدارة Edge. إذا كنت بحاجة إلى تغييرها، يمكنك تصدير مشروعك وتعديل الملفات محليًا ثم إعادة نشرها باستخدام apigeetool أو من خلال استيراد المشروع الذي تم تصديره باستخدام واجهة مستخدم الإدارة. راجِع أيضًا تصدير واستيراد وكيل باستخدام رمز Node.js.
معلومات الاستخدام الأساسية لأداة apigeetool
للحصول على معلومات أساسية حول استخدام مَعلمات الإدخال في الأداة المساعدة apigeetool، أدخِل ما يلي:
$ apigeetool deploynodeapp -h Usage: deploynodeapp -n [name] -o [organization] -e [environment] -d [directory name] -m [main script file] -u [username] -p [password] -b [base path] -l [apigee API url] -z [zip file] -i -h -o Apigee organization name -e Apigee environment name -n Apigee proxy name -d Apigee proxy directory -m Main script name: Should be at the top level of the directory -u Apigee user name -p Apigee password -b Base path (optional, defaults to /) -L Apigee API URL (optional, defaults to https://api.enterprise.apigee.com) -z ZIP file to save (optional for debugging) -i import only, do not deploy -R Resolve Node.js modules on Apigee Edge. Equivalent to running npm install on your project. -U Uploads Node.js modules to Apigee Edge. -h Print this message
إنشاء وكيل جديد باستخدام ملفات Node.js الحالية
هناك طريقة أخرى لدمج تطبيق Node.js حالي في خادم وكيل لواجهة برمجة التطبيقات، وهي إضافة التطبيق عند إنشاء الخادم الوكيل. يمكنك إجراء ذلك بالكامل من خلال واجهة مستخدم الإدارة ومربّع الحوار New API Proxy.
- من صفحة ملخّص خادم وكيل واجهة برمجة التطبيقات، انقر على + خادم وكيل لواجهة برمجة التطبيقات.
- في مربّع الحوار "خادم وكيل جديد لواجهة برمجة التطبيقات"، اختَر Node.js حالي.
- استخدِم الزر اختيار ملفات لاختيار ملف واحد أو أكثر من ملفات Node.js المطلوب استيرادها.
- أدخِل اسمًا للخادم الوكيل. في هذا المثال، سنسمّيه
hellonode. - أضِف الإصدار
/v1إلى "مسار قاعدة المشروع". يُعدّ تحديد إصدار واجهة برمجة التطبيقات من أفضل الممارسات. - انقر على إنشاء.
- انقر على تطوير للانتقال إلى طريقة عرض "التطوير".
- افتح الملف
TargetEndpointفي محرِّر الرموز. - تأكَّد من أنّ العنصر
<ScriptTarget>يحدّد ملف Node.js الرئيسي، كما يلي:
<ScriptTarget> <ResourceURL>node://server.js</ResourceURL> <Properties/> </ScriptTarget>
- انقر على حفظ.
إضافة ملفات موارد Node.js جديدة واستدعاؤها
هناك طريقة أخرى لإضافة رمز Node.js إلى وكيل، وهي إضافته مباشرةً، إما من خلال واجهة المستخدم أو عن طريق تحميله من نظام الملفات المحلي. يمكنك أيضًا تحديد ملف Node.js الذي يمثّل الملف الرئيسي، وهو الملف الذي يستدعيه Edge عند نشر الخادم الوكيل.
إضافة ملفات Node.js جديدة من خلال واجهة المستخدم
تتيح لك واجهة مستخدم الإدارة إضافة ملفات مصدر Node.js إضافية إلى خادم وكيل على منصة Edge. يمكنك إنشاء هذه الملفات مباشرةً في واجهة المستخدم أو استيرادها من نظام الملفات. أولاً، لنستعرض طريقة إجراء ذلك من واجهة المستخدم.
لإنشاء ملف مصدر جديد في Node.js، اتّبِع الخطوات التالية:
- في عرض "التطوير"، انقر على جديد نص برمجي من القائمة "جديد".
- في مربّع الحوار "إضافة نص برمجي" (Add Script)، اختَر نوع الملف Node وأدخِل اسمًا للنص البرمجي.
- انقر على إضافة.

يفتح ملف Node.js الجديد والفارغ في المحرِّر. يمكنك قص الرمز ولصقه في الملف. يظهر الملف أيضًا في قسم "النصوص البرمجية" في "المستكشف".
[[{"type":"media","view_mode":"media_large","fid":"2431","attributes":{"alt":"","class":"media-image","height":"312","typeof":"foaf:Image","width":"417"}}]]
استيراد ملفات Node.js من نظام الملفات
لاستيراد ملف Node.js من نظام الملفات إلى الخادم الوكيل، اتّبِع الخطوات التالية:
- في عرض "التطوير"، انقر على جديد نص برمجي من القائمة "جديد".
- في مربّع الحوار "إضافة نص برمجي"، انقر على استيراد نص برمجي.
- استخدِم أداة الملف لاختيار ملف Node.js.
- يتمّ إضافة اسم الملف إلى مربّع الحوار، ولكن يمكنك تغييره إذا أردت.
- انقر على إضافة. يظهر الملف في قسم "البرامج النصية" ضمن "المستكشف" ويتم فتحه في المحرِّر.
- انقر على حفظ.
إذا أردت استدعاء الملف الذي تم استيراده، عليك اتّخاذ خطوة إضافية، كما هو موضّح في القسم التالي.
استدعاء ملف Node.js مستورَد
لا يمكنك ببساطة استدعاء ملف Node.js تم استيراده أو إنشاؤه حديثًا. والسبب هو أنّ Edge يتطلّب أن يكون أحد ملفات Node.js هو ملف رئيسي. يتم تحديد الملف الرئيسي في عنصر <ScriptTarget> ضمن تعريف نقطة النهاية المستهدَفة. لتحديد الملف الذي يمثّل ملف Node.js الرئيسي، اتّبِع الخطوات التالية:
- ضِمن "نقاط النهاية المستهدَفة" في "المستكشف"، انقر على اسم نقطة النهاية المستهدَفة (عادةً ما يُطلق عليها اسم default).
- في "محرّر الرموز"، عدِّل عنصر <ScriptTarget> من خلال تغيير <ResourceURL> ليعكس اسم الملف الذي تريد أن يكون ملف Node.js الرئيسي. على سبيل المثال، إذا أردت أن يكون الملف المسمّى
hello-world.jsهو الملف الرئيسي، عليك إدخالnode://hello-world.jsفي العنصر ResourceURL. - انقر على حفظ.

في هذه المرحلة، يمكنك استدعاء الملف باستخدام أي مسار وكيل استخدمته من قبل. على سبيل المثال،
لقد اطّلعنا على المثال Hello World!، حيث تم تحديد المسار الأساسي v1/hello. ومع ذلك، يمكنك تغيير المسار الأساسي من خلال تعديل نقطة نهاية الخادم الوكيل.
- ضمن Proxy Endpoints في "المستكشف"، انقر على اسم نقطة نهاية الخادم الوكيل (يُطلق عليها عادةً default).
- في "محرّر الرموز"، عدِّل العنصر <HttpProxyConnection> من خلال تغيير <BasePath> إلى أي اسم تريده. على سبيل المثال، إذا كان <BasePath> الحالي هو
v1/helloوأردت تغييره إلىv1/my-node-file، غيِّر عنصر <BasePath> على النحو التالي:
<BasePath>/v1/my-node-file</BasePath>
- انقر على حفظ.
- استدعِ الخادم الوكيل باستخدام مسار القاعدة الجديد، على النحو التالي:
$ curl http://myorg-test.apigee.net/v1/my-node-file Hello, World!
تصدير واستيراد خادم وكيل باستخدام رمز Node.js
بعد نشر وكيل يحتوي على رمز Node.js في Edge، يمكنك دائمًا إعادة تصدير الوكيل إلى نظامك والعمل عليه هناك، ثم إعادة استيراده إلى Edge باستخدام واجهة مستخدم الإدارة. ويُستخدم هذا النوع من أساليب التطوير ذهابًا وإيابًا بشكل شائع.
- من صفحة ملخّص خادم وكيل واجهة برمجة التطبيقات، انقر على تطوير.
- في صفحة "التطوير"، انقر على تنزيل الإصدار الحالي.
- فك ضغط الملف الذي تم تنزيله على نظامك.
يمكنك إعادة استيراد حزمة الوكيل إلى Edge من خلال اختيار استيراد إلى مراجعة جديدة من القائمة نفسها.
يمكنك أيضًا استخدام واجهة برمجة التطبيقات لنشر الخوادم الوكيلة. لمزيد من التفاصيل، يُرجى الاطّلاع على نشر الخوادم الوكيلة من سطر الأوامر.
الخطوات التالية
في الموضوع التالي، إضافة Node.js إلى خادم وكيل حالي لواجهة برمجة التطبيقات، نوضّح كيفية إضافة تطبيق Node.js إلى خادم وكيل حالي في نظام الملفات ونشره على Edge.