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

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

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

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

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

البيئات

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

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

الرسائل الواردة، يتم تفعيل بروتوكول أمان طبقة النقل أو طبقة المقابس الآمنة للخادم تلقائيًا لكل بيئة. تم تحديد اثنين من VirtualHosts مسبقًا في كل بيئة: default وsecure. ويحدّد هذا الإعداد تلقائيًا عنوان HTTP، بينما يحدّد الأمان عنوان HTTP/S مع إجراء إعداد مسبق لبروتوكول أمان طبقة النقل (TLS)/طبقة المقابس الآمنة (SSL) من جهة الخادم. في إعدادات الخادم الوكيل لواجهة برمجة التطبيقات، يمكنك الإشارة إلى VirtualHosts التي يجب أن يستمع إليها 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>

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

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

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

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

لمزيد من المعلومات، راجِع فهم عملية النشر.

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

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

الترويج للمنتج

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

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

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

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

موارد البيئة

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

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

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

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

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