دورة تطوير واجهة برمجة التطبيقات

أنت تطّلع على مستندات Apigee Edge.
انتقِل إلى مستندات Apigee X. المعلومات

لكل مؤسسة دورة حياة فريدة لتطوير البرامج (SDLC). غالبًا ما يكون من الضروري مزامنة وتنسيق عمليات نشر الوكيل لواجهة برمجة التطبيقات مع العمليات نفسها التي تستخدمها حاليًا لأجل تطوير التطبيقات الأخرى واختبارها ونشرها.

توفّر "خدمات واجهة برمجة التطبيقات" أدوات وواجهات برمجة تطبيقات RESTful تتيح لك دمج عملية نشر وكيل واجهة برمجة التطبيقات وإدارته في دورة تطوير البرامج (SDLC) لمؤسستك. من الاستخدامات الشائعة لواجهات برمجة التطبيقات RESTful API كتابة نصوص برمجية أو رموز برمجية تعمل على نشر أدوات إعادة التوجيه لواجهات برمجة التطبيقات آليًا أو نقلها من بيئة إلى أخرى، وذلك كجزء من عملية آلية أكبر تعمل أيضًا على نشر تطبيقات أخرى أو نقلها. لا تقدّم "خدمات واجهة برمجة التطبيقات" افتراضات حول SDLC (أو أي افتراضات لدى أي مستخدم آخر في هذا الشأن). بدلاً من ذلك، تعرِض وظائف أساسية يمكن لفريق التطوير تنسيقها لبرمجة دورة حياة تطوير واجهة برمجة التطبيقات وتحسينها.

تم توثيق واجهات برمجة التطبيقات لخدمات واجهة برمجة التطبيقات في مرجع واجهة برمجة التطبيقات. اطّلِع على مرجع واجهة برمجة التطبيقات للبدء.

البيئات

تتوفّر لكل مؤسسة على Apigee Edge بيئتا نشر على الأقل متوفرة لخوادم الوكيل لـ API: "test" و"prod". ويكون الفرق بين البيئتين عشوائيًا، إذ يتم تحديد كل بيئة من خلال مجموعة مختلفة من عناوين الشبكة (عناوين URL). والهدف من ذلك هو تزويدك بنطاق يمكنك من خلاله إنشاء خوادم وكيلة لواجهة برمجة التطبيقات والتحقق منها قبل أن تظهر واجهة برمجة التطبيقات للمطوّرين الخارجيين.

يمكنك الاستفادة من هذه البيئات لمزامنة تطوير الخادم الوكيل لواجهة برمجة التطبيقات التي تمت معالجتها باستخدام تنسيق SDLC. يتم تحديد كل بيئة من خلال عنوان شبكة، ما يتيح لك فصل الزيارات بين الخوادم الوكيلة لواجهات برمجة التطبيقات التي تعمل عليها، والخوادم الوكيلة التي تصل إليها التطبيقات أثناء التشغيل. يتم تحديد عناوين الشبكة المتاحة لكل بيئة في مجموعة VirtualHosts المتاحة في تلك البيئة.

الرسائل الواردة، يتم تفعيل بروتوكول أمان طبقة النقل (TLS)/طبقة المقابس الآمنة (SSL) الخاصة بالخادم تلقائيًا لكل بيئة. تم تحديد مضيفَين افتراضيَين مسبقًا في كل بيئة: default وsecure. يحدِّد الخيار "تلقائي" عنوان HTTP، في حين يحدِّد الخيار "آمن" عنوان HTTP/S، مع بروتوكول أمان طبقة النقل (TLS) أو طبقة المقابس الآمنة (SSL) المُعدّ مسبقًا من جهة الخادم. في إعدادات خادم وكيل واجهة برمجة التطبيقات، يمكنك تحديد Hosts الافتراضية التي يجب أن يستمع إليها ProxyEndpoint. عند الترقية إلى إصدار علني، يتم عادةً إيقاف HTTP عن طريق إزالة default VirtualHost من إعدادات وكيل واجهة برمجة التطبيقات.

على سبيل المثال، يستمع ProxyEndpoint التالي إلى HTTP وHTTPS.

<HTTPProxyConnection>
  <BasePath>/v0/weather</BasePath>
  <Properties/>
  <VirtualHost>default</VirtualHost>
  <VirtualHost>secure</VirtualHost>
</HTTPProxyConnection>

من خلال حذف default VirtualHost من إعدادات ProxyEndpoint، يمكنك إنشاء خادم وكيل لواجهة برمجة التطبيقات يستمع إلى HTTPS فقط وليس إلى HTTP.

<HTTPProxyConnection>
  <BasePath>/v0/weather</BasePath>
  <Properties/>
  <VirtualHost>secure</VirtualHost>
</HTTPProxyConnection>

يمكنك الاطّلاع على المضيفات الافتراضية المتاحة في بيئة معيّنة من خلال اختيار البيئات في القائمة الرئيسية لواجهة مستخدم الإدارة.

توفّر البيئات أيضًا فصل البيانات والموارد. ويمكنك على سبيل المثال إعداد ذاكرات تخزين مؤقتة مختلفة في الاختبار والإنتاج، والتي لا يمكن الوصول إليها إلا من خلال الخوادم الوكيلة لواجهة برمجة التطبيقات التي يتم تنفيذها في تلك البيئة. بالإضافة إلى ذلك، مفاتيح واجهة برمجة التطبيقات التي يتم إصدارها في بيئة الاختبار غير صالحة في بيئة الإنتاج والعكس صحيح.

نشر أدوات الربط لواجهات برمجة التطبيقات في البيئات

عند إنشاء وكيل لواجهة برمجة التطبيقات، عليك تحديد البيئة التي ستستخدمها. يمكنك اختيار إنشاء خادم وكيل جديد لواجهة برمجة التطبيقات في مرحلة الإنتاج، ولكن لا ننصح بذلك لأنّه قد تعرض واجهة برمجة التطبيقات للمطوّرين قبل أن تصبح جاهزة. بشكل عام، ابدأ بإنشاء وكيل لواجهة برمجة التطبيقات في test، ثم انقل هذا الوكيل إلى مرحلة اختبار الأداء في prod.

لمزيد من المعلومات، يمكنك الاطّلاع على فهم عملية النشر.

التطور المتكرر في الاختبار

أثناء العمل على خادم وكيل لواجهة برمجة التطبيقات، تحفظ "خدمات واجهة برمجة التطبيقات" نُسخًا من الإعدادات على هيئة مراجعات. عند نشر وكيل واجهة برمجة التطبيقات، يمكنك اختيار إصدار معيّن لنشره. يتم عادةً نشر أحدث نسخة، ويمكنك العودة إلى رقم النسخة السابقة إذا لزم الأمر. ويمكنك اختيار مكان نشر هذه المراجعات. على سبيل المثال، يمكنك ترقية مراجعة إلى الإصدار العلني للسماح للمطوّرين ببدء العمل باستخدام واجهة برمجة التطبيقات. وفي الوقت نفسه، قد يتم تكرار مراجعات متعددة أثناء الاختبار، إذ تتم إضافة ميزات أو إجراءات لضبط السياسات عليها. بعد ذلك، عندما تكون مستعدًا، يمكنك نشر النسخة الجديدة في قناة الإصدار العلني، مع استبدال النسخة الحالية في تلك البيئة. وباستخدام هذه الطريقة، يمكنك إتاحة نسخة مباشرة من واجهة برمجة التطبيقات للمطوّرين في أي وقت أثناء عملية التطوير.

الترقية إلى إصدار علني

عند تنفيذ وكيل واجهة برمجة التطبيقات واختباره بالكامل، يصبح جاهزًا للترقية إلى "الإصدار العلني". سيتم استخدام نسخة واجهة برمجة التطبيقات الوكيلة في الاختبار لاستبدال نسخة واجهة برمجة التطبيقات الوكيلة التي تم نشرها في قناة الإصدار العلني.

توفّر "خدمات واجهة برمجة التطبيقات" إمكانات لضمان نشر أدوات الربط لواجهات برمجة التطبيقات بسلاسة، ما يقلل من التأثير على التطبيقات والمستخدمين النهائيين أثناء عملية النشر.

نشر النصوص البرمجية

تتيح لك واجهة مستخدم إدارة Apigee Edge نشر الخوادم الوكيلة لواجهات برمجة التطبيقات في قناة الإصدار مباشرةً من أداة إنشاء الخوادم الوكيلة لواجهات برمجة التطبيقات. ومع ذلك، في العديد من الحالات، ستفرض متطلبات الأمان والموثوقية والاتساق على فِرق التطوير إجراءات نشر النصوص البرمجية. ولإجراء ذلك، يمكنك كتابة الرموز البرمجية والنصوص البرمجية التي تستدعي واجهة برمجة التطبيقات RESTful التي تعرضها "خدمات واجهة برمجة التطبيقات".

موارد البيئة

للحصول على عناصر تحكّم إضافية أثناء عرض المحتوى الترويجي، ننصحك بإجراء عمليات تكرار على مثيل واجهة برمجة التطبيقات في الإصدار التجريبي فقط، وإجراء أقل عدد ممكن من التغييرات على مثيل واجهة برمجة التطبيقات الذي تم نشره في الإصدار العلني.

ولإجراء ذلك، عليك التأكّد من أنّه تم ضبط موارد معيّنة مرتبطة بكل بيئة بطريقة تسمح لها بالبقاء ثابتة في إعدادات خادم وكيل واجهة برمجة التطبيقات.

• عناوين URL المستهدَفة: من الشائع أن تستدعي أدوات الربط بين واجهة برمجة التطبيقات عناوين URL مختلفة للخلفية أثناء الاختبار والإنتاج. يمكنك استخدام إعدادات TargetServer لإنشاء إعدادات TargetEndpoint مستقلة عن البيئة. اطّلِع على موازنة الحمل على مستوى خوادم الخلفية.
• ذاكرات التخزين المؤقت وخرائط المفتاح/القيمة: يتم تحديد نطاق كل من موارد الاحتفاظ بالبيانات حسب البيئة. عليك التأكّد من استخدام اصطلاحات التسمية لتفعيل أدوات الربط بين واجهة برمجة التطبيقات لتخزين البيانات بدون الحاجة إلى إجراء تغييرات على الإعدادات أثناء العرض الترويجي. اطّلِع على إنشاء ذاكرة تخزين مؤقت للبيئة وتعديلها.
• استهدافات ServiceCallout: قد تستخدِم قوائم ServiceCallout استهدافات مختلفة استنادًا إلى البيئة، على سبيل المثال، إذا كان ServiceCallout في البيئة الاختبارية يستخدِم خدمة تجريبية. يُرجى الاطّلاع على سياسة وسيلة شرح الخدمة.

لجعل إعدادات الخادم الوكيل لواجهة برمجة التطبيقات مستقلة عن البيئة، يمكنك أيضًا استخدام عبارات الشَرطية. يمكن استخدام العبارة الشَرطية التي تم إنشاؤها باستخدام المتغيّر environment.name لتقييم البيئة الحالية قبل فرض سياسة أو قبل التوجيه إلى عنوان URL في الخلفية.

لمزيد من المعلومات، يُرجى الاطّلاع على فهم عملية النشر.