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

أنت الآن بصدد الاطّلاع على مستندات Apigee Edge.
انتقِل إلى مستندات Apigee X. info

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

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

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

البيئات

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

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

يتم تلقائيًا تفعيل بروتوكول أمان طبقة النقل (TLS) أو بروتوكول طبقة المقابس الآمنة (SSL) الوارد للخادم لكل بيئة. يتم تحديد مضيفَين افتراضيَين مسبقًا في كل بيئة: 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 API التي تعرضها "خدمات واجهات برمجة التطبيقات".

المراجع البيئية

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

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

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

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

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