تمت ترجمة هذه الصفحة بواسطة Cloud Translation API‏.

إنشاء خادم وكيل بسيط لواجهة برمجة التطبيقات

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

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

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

شاهِد هذا الفيديو للحصول على نظرة عامة حول عملية إنشاء خادم وكيل لواجهة برمجة التطبيقات.

إنشاء خادم وكيل لواجهة برمجة التطبيقات باستخدام واجهة المستخدم

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

Edge

للوصول إلى معالج "إنشاء خادم وكيل" باستخدام واجهة مستخدم Edge:

سجِّل الدخول إلى apigee.com/edge.
اختَر التطوير > الخوادم الوكيلة لواجهة برمجة التطبيقات في شريط التنقل الأيمن.
انقر على +خادم وكيل.

يعرض معالج "إنشاء خادم وكيل" ويرشدك خلال الخطوات اللازمة لإنشاء الحد الأدنى من الميزات وإضافتها إلى الخادم الوكيل لواجهة برمجة التطبيقات.

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

الإصدار الكلاسيكي Edge (السحابة الإلكترونية الخاصة)

للوصول إلى معالج "إنشاء خادم وكيل" باستخدام واجهة مستخدم Edge الكلاسيكي:

سجّل الدخول إلى http://ms-ip:9000، حيث ms-ip هو عنوان IP أو اسم نظام أسماء النطاقات لعقدة خادم الإدارة.
حدد APIs > الخوادم الوكيلة لواجهة برمجة التطبيقات في شريط التنقل العلوي.
انقر على + خادم وكيل لواجهة برمجة التطبيقات.

تتيح لك الصفحة الأولى في المعالج إنشاء خادم وكيل لواجهة برمجة التطبيقات من المصادر التالية:

النوع	الوصف
الوكيل العكسي (الأكثر شيوعًا)	خادم وكيل لواجهة برمجة تطبيقات يوجِّه الطلبات الواردة إلى خدمات واجهة HTTP الخلفية الحالية. يمكن أن يكون واجهة برمجة تطبيقات JSON أو XML. راجِع إنشاء خادم وكيل عكسي لخدمة HTTP لاحقًا في هذا القسم. انقر على استخدام مواصفات OpenAPI لإنشاء الخادم الوكيل من واجهة OpenAPI صالحة. المواصفات لمزيد من المعلومات حول هذا الخيار، راجع استخدام OpenAPI مواصفات إنشاء الخوادم الوكيلة لاحقًا في هذا القسم
خدمة SOAP	خادم وكيل لواجهة برمجة التطبيقات تم إنشاؤه من ملف WSDL. يُرجى الاطّلاع على كشف خدمة ويب مستندة إلى SOAP كخادم وكيل لواجهة برمجة تطبيقات.
بلا هدف	خادم وكيل لواجهة برمجة تطبيقات بدون خلفية واجهة برمجة تطبيقات ("بلا هدف") مشابه لـ إنشاء خادم وكيل عكسي لخدمة HTTP كما هو موضح سابقًا، إلا أنك لن تحدد واجهة برمجة تطبيقات حالية عند تحديد تفاصيل الخادم الوكيل لواجهة برمجة التطبيقات. انقر على استخدام مواصفات OpenAPI لإنشاء الخادم الوكيل من واجهة OpenAPI صالحة. المواصفات. لمزيد من المعلومات حول هذا الخيار، راجع استخدام OpenAPI مواصفات إنشاء الخوادم الوكيلة لاحقًا في هذا القسم
الهدف المستضاف	خادم وكيل لواجهة برمجة تطبيقات يوجِّه إلى تطبيق Node.js يتم نشره في بيئة الأهداف المستضافة. اطّلِع على نظرة عامة على الأهداف المستضافة.
تحميل حزمة الخادم الوكيل	حزمة حالية لخادم وكيل لواجهة برمجة التطبيقات (على سبيل المثال، أحد نماذج الخوادم الوكيلة لواجهة برمجة التطبيقات المتوفرة على GitHub.) راجِع استيراد خادم وكيل لواجهة برمجة التطبيقات من حزمة خادم وكيل لواجهة برمجة التطبيقات.

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

إنشاء وكيل عكسي لخدمة HTTP

تنشئ Edge خوادم وكيلة عكسية استنادًا إلى نوعين من المعلومات:

عنوان URL لخدمة الخلفية
مسار معرّف الموارد المنتظم (URI) الذي يعرّف بشكل فريد واجهة برمجة التطبيقات التي سيتم عرضها بواسطة الخادم الوكيل لواجهة برمجة التطبيقات تطبيقات المستهلك

يمثل عنوان URL لخدمة الخلفية عادةً تطبيقًا تم تفعيل الخدمة ويمتلكه التنظيم. ويمكن أن يشير أيضًا إلى واجهة برمجة تطبيقات متاحة للجميع. قد تكون واجهة برمجة التطبيقات أو الخدمة ضمن (على سبيل المثال، تطبيق الموارد البشرية الداخلي أو تطبيق Rails في السحابة) أو يمكن تكون واجهة برمجة تطبيقات أو خدمة تابعة لجهة خارجية (مثل Twitter أو Instagram).

Edge

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

في صفحة التفاصيل للمعالج، أدخِل المعلومات التالية.

الحقل	الوصف
الاسم	الاسم المعروض لواجهة برمجة التطبيقات. حدِّد الأحرف الأبجدية الرقمية أو الشرطة (-) أو الشرطة السفلية (_).
المسار الأساسي	جزء معرِّف الموارد المنتظم (URI) الذي يظهر بعد عنوان http(s)://[host] الخادم الوكيل لواجهة برمجة التطبيقات. تستخدم شبكة Edge معرِّف الموارد المنتظم (URI) للمسار الأساسي لمطابقة رسائل الطلبات الواردة وتوجيهها إلى الخادم الوكيل لواجهة برمجة التطبيقات المناسبة. ملاحظة: الإعداد التلقائي للمسار الأساسي للخادم الوكيل لواجهة برمجة التطبيقات على القيمة المحدّدة تم تحويل الحقل `Name` إلى أحرف صغيرة بالكامل. بعد المسار الأساسي، ستظهر أي عناوين URL إضافية للموارد. إليك عنوان URL الكامل البنية التي سيستخدمها العملاء لطلب الخادم الوكيل لواجهة برمجة التطبيقات: `https://[host]/base_path/conditional_flow_path` ملاحظة: يجب أن يكون المسار الأساسي فريدًا، لا يمكنك نشر خادمين وكيلين لواجهة برمجة التطبيقات باستخدام الأساسي. في حال تعديل خادم وكيل لواجهة برمجة تطبيقات تم نشره وتضبط المسار الأساسي على القيمة نفسها المستخدَمة في المسار الأساسي لخادم وكيل آخر لواجهة برمجة التطبيقات، تزيل Edge عملية النشر تلقائيًا الخادم الوكيل لواجهة برمجة التطبيقات عند حفظه. قبل أن تتمكّن من إعادة نشر الخادم الوكيل لواجهة برمجة التطبيقات، يجب تعديل المسار الأساسي ليصبح فريدًا. استخدام أحرف البدل في المسارات الأساسية يمكنك استخدام حرف بدل واحد أو أكثر من أحرف `//` في المسارات الأساسية للخادم الوكيل لواجهة برمجة التطبيقات من أجل الخوادم الوكيلة لواجهة برمجة التطبيقات لمواكبة التغييرات المستقبلية. على سبيل المثال، المسار الأساسي لـ `/team//members` يسمح للعملاء بالاتصال بـ `https://[host]/team/blue/members` و`https://[host]/team/green/members` بدونك الحاجة إلى إنشاء خوادم وكيلة جديدة لواجهة برمجة التطبيقات لدعم الفرق الجديدة. لاحظ أن `/**/` ليس
الوصف	(اختياري) وصف واجهة برمجة التطبيقات
الاستهداف (واجهة برمجة التطبيقات الحالية)	عنوان URL لخدمة الخلفية التي يستدعيها الخادم الوكيل لواجهة برمجة التطبيقات هذا.

في صفحة السياسات الشائعة بالمعالج، اضبط ما يلي:
- متطلبات تفويض الأمان ضمن الأمان: التفويض. راجع إضافة الأمان لاحقًا في هذا القسم.
- إتاحة مشاركة الموارد مع نطاقات خارجية (CORS) ضمن الأمان: المتصفّح راجع إضافة إمكانية استخدام سياسة مشاركة الموارد المتعددة المصادر (CORS) لاحقًا في هذا القسم.
- الحصص لحماية خدمتك الخلفية من عدد الزيارات المرتفع ضمن الحصة راجِع الحصص. (هذه الميزة غير متاحة في حال اختيار تفويض التمرير).
- فرض حدود تحقيق الربح للمؤسسات التي تم تفعيل ميزة تحقيق الربح فيها ضمن تحقيق الربح راجِع فرض حدود تحقيق الربح على الخوادم الوكيلة لواجهة برمجة التطبيقات.
في صفحة المضيفات الافتراضية بالمعالج، حدِّد المضيفات الافتراضية التي سيرتبط بها الخادم الوكيل لواجهة برمجة التطبيقات عند نشره. لمزيد من المعلومات، يُرجى الاطّلاع على لمحة عن خدمات الاستضافة الافتراضية.
في صفحة الملخّص، اختَر بيئات النشر، إذا كنت تريد ذلك، وانقر على إنشاء ونشر.
تم إنشاء الخادم الوكيل الجديد لواجهة برمجة التطبيقات ونشرها في البيئة المحددة.
انقر على تعديل الخادم الوكيل لعرض صفحة التفاصيل للخادم الوكيل لواجهة برمجة التطبيقات.

الإصدار الكلاسيكي Edge (السحابة الإلكترونية الخاصة)

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

في صفحة التفاصيل للمعالج، أدخِل المعلومات التالية.

الحقل	الوصف
اسم الوكيل	الاسم المعروض لواجهة برمجة التطبيقات.
المسار الأساسي للخادم الوكيل	المسار الأساسي للخادم الوكيل هو جزء من عنوان URI بعد عنوان http(s)://[host] الخادم الوكيل لواجهة برمجة التطبيقات. تستخدم شبكة Edge "معرّف الموارد المنتظم (URI) لمسار Base" لمطابقة رسائل الطلبات الواردة وتوجيهها. إلى الخادم الوكيل لواجهة برمجة التطبيقات المناسبة. ملاحظة: للحصول على اقتراحات Apigee حول تحديد إصدارات واجهة برمجة التطبيقات، راجِع تحديد الإصدارات في Web API Design: The lost Link. كتاب إلكتروني. بعد المسار الأساسي، تظهر أيّ عناوين URL إضافية للموارد. إليك عنوان URL الكامل البنية التي سيستخدمها العملاء لطلب الخادم الوكيل لواجهة برمجة التطبيقات: `https://[host]/base_path/conditional_flow_path` ملاحظة: يجب أن يكون المسار الأساسي فريدًا. إذا عدّلت هذا الخادم الوكيل لاحقًا وتعيين مساره الأساسي ليكون مطابقًا لخادم وكيل آخر لواجهة برمجة التطبيقات، فإن الخادم الوكيل لواجهة برمجة التطبيقات هذا يتم إلغاء نشرها تلقائيًا عند حفظها. يجب تعديل المسار الأساسي قبل فيمكنك إعادة نشرها. استخدام حرف بدل في المسارات الأساسية يمكنك استخدام حرف بدل واحد أو أكثر من أحرف `//` في المسارات الأساسية لخادم وكيل واجهة برمجة التطبيقات من أجل وحماية خوادمك الوكيلة للمستقبل. على سبيل المثال، المسار الأساسي لـ `/team//members` يسمح للعملاء بالاتصال بـ `https://[host]/team/blue/members` و`https://[host]/team/green/members` بدونك الحاجة إلى إنشاء خوادم وكيلة جديدة لواجهة برمجة التطبيقات لدعم الفرق الجديدة. لاحظ أن // ليس ملاحظة**: يتم ضبط المسار الأساسي للخادم الوكيل تلقائيًا على القيمة المحدّدة تم تحويل اسم الخادم الوكيل إلى أحرف صغيرة ما لم تعدّل المحتوى بشكل صريح في مسار قاعدة الخادم الوكيل.
واجهة برمجة التطبيقات الحالية	عنوان URL الذي يستدعيه النظام الأساسي لواجهة برمجة التطبيقات نيابةً عن التطبيقات التي تستدعي واجهة برمجة التطبيقات من خلال عنوان URL للخادم الوكيل لواجهة برمجة التطبيقات.
الوصف	وصف واجهة برمجة التطبيقات.

في صفحة الأمان بالمعالج، اضبط ما يلي:
- متطلبات مصادقة الأمان راجع إضافة الأمان لاحقًا في هذا القسم.
- إتاحة مشاركة الموارد مع نطاقات خارجية (CORS). راجع إضافة إمكانية استخدام سياسة مشاركة الموارد المتعددة المصادر (CORS) لاحقًا في هذا القسم.
في صفحة المضيفات الافتراضية بالمعالج، اختر المضيفات الافتراضية التي سيرتبط بها الخادم الوكيل لواجهة برمجة التطبيقات عند النشر. لمزيد من المعلومات، يُرجى الاطّلاع على لمحة عن خدمات الاستضافة الافتراضية.
اختَر بيئات النشر وانقر على إنشاء ونشر
تم إرسال إقرار يؤكد إنشاء الخادم الوكيل الجديد لواجهة برمجة التطبيقات بنجاح. ونشرها في البيئة المحددة.
انقر على عرض <اسم الخادم الوكيل> الخادم الوكيل في المحرِّر لعرض صفحة التفاصيل للخادم الوكيل لواجهة برمجة التطبيقات.

استيراد خادم وكيل لواجهة برمجة التطبيقات من خادم وكيل لواجهة برمجة التطبيقات مجموعة

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

شاهِد هذا الفيديو للتعرّف على كيفية إنشاء خادم وكيل لواجهة برمجة تطبيقات واستيراده من خادم وكيل لواجهة برمجة تطبيقات. حُزم.

Edge

لاستيراد الخوادم الوكيلة لواجهة برمجة التطبيقات من حزمة خادم وكيل لواجهة برمجة التطبيقات:

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

في صفحة تحميل حزمة الخادم الوكيل في معالج الخادم الوكيل، أدخِل المعلومات التالية.

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

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

الإصدار الكلاسيكي Edge (السحابة الإلكترونية الخاصة)

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

في صفحة التفاصيل في معالج الخادم الوكيل، أدخِل المعلومات التالية.

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

راجِع معلومات الإصدار وانقر على إنشاء.
في حال نجاح ذلك، يتم عرض رسالة وينشر Edge تلقائيًا الخادم الوكيل لواجهة برمجة التطبيقات التي تم استيرادها في البيئة المحددة. في مؤسستك. تكون واجهة برمجة التطبيقات التي يعرضها الخادم الوكيل لواجهة برمجة التطبيقات متاحة للاستدعاء.
انقر على عرض <اسم الخادم الوكيل> الخادم الوكيل في المحرّر لعرض صفحة التفاصيل للخادم الوكيل لواجهة برمجة التطبيقات.
لتفعيل الخادم الوكيل، انقر على القائمة المنسدلة النشر واختَر بيئة التشغيل التي تريد النشر فيها والرد على المطالبة.

عرض خدمة ويب تستند إلى SOAP على أنها واجهة برمجة تطبيقات الوكيل

في معالج "إنشاء خادم وكيل"، انقر على SOAP Service، واتّبع المعالج إنشاء خادم وكيل يعتمد على التمرير أو REST لخدمة SOAP. لمعرفة التفاصيل، يُرجى الاطّلاع على التعرّض للضوء. خدمة SOAP كخادم وكيل لواجهة برمجة التطبيقات.

جارٍ إضافة مستوى أمان

في صفحة السياسات الشائعة (Edge) أو الأمان (الإصدار الكلاسيكي Edge) من معالج إنشاء الخادم الوكيل، اختَر نوع تفويض الأمان الذي تريد إضافته. يلخّص الجدول التالي الخيارات المتاحة:

تفويض الأمان	الوصف
مفتاح واجهة برمجة التطبيقات	إضافة إثبات الملكية البسيط لمفتاح واجهة برمجة التطبيقات إلى الخادم الوكيل لواجهة برمجة التطبيقات الذي تستخدمه التحديد. استجابةً لذلك، تضيف منصة واجهة برمجة التطبيقات سياسة "التحقق من واجهة برمجة التطبيقات" وسياسة AssignMessage. إلى الخادم الوكيل لواجهة برمجة التطبيقات. تتحقّق سياسة CheckAPIKey من مفاتيح واجهة برمجة التطبيقات التي يتم عرضها من خلال طلب التطبيقات. تشير رسالة الأشكال البيانية تزيل سياسة assignMessage مفتاح واجهة برمجة التطبيقات، الذي يتم توفيره في طلب بيانات من واجهة برمجة التطبيقات كمَعلمة طلب بحث، من إعادة توجيه الطلب إلى خادم الخلفية.
OAuth 2.0	تضيف المصادقة المستندة إلى بروتوكول OAuth 2.0 إلى الخادم الوكيل لواجهة برمجة التطبيقات. يضيف Apigee Edge سياستَين تلقائيًا إلى الخادم الوكيل لواجهة برمجة التطبيقات: إحداهما سياسة للتحقق من رمز الدخول وسياسة أخرى لإزالة رمز الدخول من الرسالة قبل إعادة توجيهه إلى خدمة الخلفية. لمعرفة كيفية الحصول على رمز دخول، يُرجى الاطّلاع على OAuth.
المرور (بدون إذن)	لا يلزم الحصول على إذن. يتم تمرير الطلبات إلى الواجهة الخلفية بدون إجراء أي فحوصات أمنية على Apigee Edge.

إتاحة استخدام سياسة مشاركة الموارد المتعددة المصادر (CORS)

إنّ CORS (مشاركة الموارد المتعددة المصادر) هي آلية قياسية تسمح لمتصفّح الويب بإنشاء توجيه الطلبات إلى نطاق آخر. يحدد معيار CORS مجموعة من عناوين HTTP التي المتصفحات والخوادم لتنفيذ الاتصال عبر النطاقات.

يمكنك إضافة دعم سياسة مشاركة الموارد المتعددة المصادر (CORS) إلى واجهة برمجة التطبيقات عن طريق اختيار إضافة عناوين سياسة مشاركة الموارد المتعددة المصادر (CORS) في صفحة السياسات الشائعة (Edge) أو الأمان (الإصدار الكلاسيكي Edge) في معالج إنشاء الخادم الوكيل.

للحصول على معلومات أكثر تفصيلاً حول دعم سياسة مشاركة الموارد المتعددة المصادر (CORS)، بما في ذلك إضافة دعم الطلب المبدئي لسياسة مشاركة الموارد المتعددة المصادر (CORS). إلى الخادم الوكيل، راجع إضافة سياسة مشاركة الموارد المتعددة المصادر (CORS) التوافق مع الخادم الوكيل لواجهة برمجة التطبيقات.

استخدام مواصفات OpenAPI لإنشاء خوادم وكيلة

يناقش هذا القسم خيار استخدام OpenAPI المتاح للإنشاء من واجهة OpenAPI. يجب تحديد الأنواع التالية من الخوادم الوكيلة لواجهة برمجة التطبيقات: عكس أو Node.js أو عدم هدف.

ما هي مواصفات OpenAPI؟

شعار "مبادرة واجهة برمجة التطبيقات المفتوحة" (Open API Initiative) "تركّز "مبادرة واجهة برمجة التطبيقات المفتوحة" (OAI) على إنشاء وتطوير وترويج تنسيق وصف واجهة برمجة تطبيقات محايد للمورّد بناءً على نموذج التخاطر المواصفات". لمزيد من المعلومات حول مبادرة واجهة برمجة التطبيقات المفتوحة، يمكنك الاطّلاع على https://openapis.org.

تستخدم مواصفات OpenAPI تنسيقًا عاديًا لوصف واجهة برمجة تطبيقات RESTful. تكون مواصفات OpenAPI مكتوبة إما بتنسيق JSON أو YAML، ويمكن قراءتها آليًا، ولكنها أيضًا يسهل على الأشخاص قراءتها وفهمها. تصف المواصفات عناصر واجهة برمجة التطبيقات على النحو التالي مساره الأساسي، والمسارات والأفعال، والعناوين، ومعلمات طلب البحث، والعمليات، وأنواع المحتوى، والاستجابة والأوصاف وغيرها. بالإضافة إلى ذلك، تُستخدم مواصفات OpenAPI بشكل شائع لإنشاء واجهة برمجة التطبيقات التوثيق.

وفي ما يلي جزء من مواصفات OpenAPI تصف خدمة الهدف الوهمية في Apigee، http://mocktarget.apigee.net. بالنسبة لمزيد من المعلومات، يُرجى الاطّلاع على https://github.com/apigee/api-platform-samples/tree/master/default-proxies/helloworld/openapi.

openapi: 3.0.0
info:
  description: OpenAPI Specification for the Apigee mock target service endpoint.
  version: 1.0.0
  title: Mock Target API
paths:
  /:
    get:
      summary: View personalized greeting
      operationId: View a personalized greeting
      description: View a personalized greeting for the specified or guest user.
      parameters:
        - name: user
          in: query
          description: Your user name.
          required: false
          schema:
            type: string
      responses:
        "200":
          description: Success
  /help:
    get:
      summary: Get help
      operationId: Get help
      description: View help information about available resources in HTML format.
      responses:
        "200":
          description: Success
...

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

إنشاء خادم وكيل لواجهة برمجة تطبيقات من مواصفات OpenAPI

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

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

شاهد هذا الفيديو لمعرفة كيفية إنشاء خادم وكيل لواجهة برمجة تطبيقات من مواصفات OpenAPI.

تعديل التدفقات في خادم وكيل لواجهة برمجة التطبيقات باستخدام مواصفات OpenAPI

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

لتعديل التدفقات في خادم وكيل لواجهة برمجة التطبيقات باستخدام مواصفات OpenAPI:

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

تتم إضافة التدفقات الشرطية إلى الخادم الوكيل لواجهة برمجة التطبيقات.

إنشاء نسخة جديدة من خادم وكيل لواجهة برمجة التطبيقات

أنشئ نسخة جديدة من الخادم الوكيل لواجهة برمجة التطبيقات، كما هو موضَّح أدناه.

Edge

لإنشاء نسخة جديدة من الخادم الوكيل لواجهة برمجة التطبيقات باستخدام واجهة مستخدم Edge:

سجِّل الدخول إلى apigee.com/edge.
اختَر التطوير > الخوادم الوكيلة لواجهة برمجة التطبيقات في شريط التنقل الأيمن.
انقر على الخادم الوكيل لواجهة برمجة التطبيقات في القائمة التي تريد نسخها.
اختَر مشروع >. حفظ كنسخة جديدة.

الإصدار الكلاسيكي Edge (السحابة الإلكترونية الخاصة)

لإنشاء نسخة جديدة من الخادم الوكيل لواجهة برمجة التطبيقات باستخدام واجهة مستخدم Edge الكلاسيكية:

سجّل الدخول إلى http://ms-ip:9000، حيث ms-ip هو عنوان IP أو اسم نظام أسماء النطاقات لعقدة خادم الإدارة.
حدد APIs > الخوادم الوكيلة لواجهة برمجة التطبيقات في شريط التنقل العلوي.
انقر على الخادم الوكيل لواجهة برمجة التطبيقات في القائمة التي تريد نسخها.
اختَر مشروع >. حفظ كنسخة جديدة.

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

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

Edge

لنسخ خادم وكيل لواجهة برمجة تطبيقات باستخدام واجهة مستخدم Edge:

سجِّل الدخول إلى apigee.com/edge.
اختَر التطوير > الخوادم الوكيلة لواجهة برمجة التطبيقات في شريط التنقل الأيمن.
انقر على الخادم الوكيل لواجهة برمجة التطبيقات في القائمة التي تريد نسخها.
اختَر مشروع >. الحفظ كخادم وكيل جديد لواجهة برمجة التطبيقات
في مربع الحوار "حفظ كخادم وكيل جديد"، أدخِل اسم الخادم الوكيل الجديد لواجهة برمجة التطبيقات.
انقر على إضافة.

الإصدار الكلاسيكي Edge (السحابة الإلكترونية الخاصة)

لنسخ خادم وكيل لواجهة برمجة تطبيقات باستخدام واجهة مستخدم Edge الكلاسيكي:

سجّل الدخول إلى http://ms-ip:9000، حيث ms-ip هو عنوان IP أو اسم نظام أسماء النطاقات لعقدة خادم الإدارة.
حدد APIs > الخوادم الوكيلة لواجهة برمجة التطبيقات في شريط التنقل العلوي.
انقر على الخادم الوكيل لواجهة برمجة التطبيقات في القائمة التي تريد نسخها.
اختَر مشروع >. الحفظ كخادم وكيل جديد لواجهة برمجة التطبيقات
في مربع الحوار "حفظ كخادم وكيل جديد"، أدخِل اسم الخادم الوكيل الجديد لواجهة برمجة التطبيقات.
انقر على إضافة.

الاحتفاظ بنسخة احتياطية من خادم وكيل لواجهة برمجة التطبيقات

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

إنشاء خادم وكيل لواجهة برمجة التطبيقات باستخدام واجهة برمجة التطبيقات

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