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

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

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

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

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

البيئات

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

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

الرسائل الواردة، يتم تفعيل بروتوكول أمان طبقة النقل (TLS)/طبقة المقابس الآمنة للخادم تلقائيًا لكل بيئة. يتم تحديد اثنين من 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 لإنشاء عمليات ضبط مستقلة لنقطة نهاية الاستهداف. يُرجى الاطّلاع على موازنة الحمل عبر خوادم الخلفية.
• ذاكرات التخزين المؤقت وخرائط المفتاح/القيم: يتم تحديد موارد المثابرة حسب البيئة. يجب التأكد من استخدام اصطلاحات التسمية لتمكين الخوادم الوكيلة لواجهة برمجة التطبيقات من تخزين البيانات بدون الحاجة إلى إجراء تغييرات في الإعداد أثناء العرض الترويجي. راجِع إنشاء ذاكرة تخزين مؤقت للبيئة وتعديلها.
• أهداف وسائل شرح الخدمة: قد تستخدم وسائل شرح الخدمة أهدافًا مختلفة بناءً على البيئة، إذا كانت ServiceCallout على سبيل المثال في بيئة الاختبار تستخدم خدمة تجريبية. يُرجى الاطّلاع على سياسة وسائل شرح الخدمة.

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

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