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

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

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

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

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

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

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

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

Edge

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

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

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

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

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

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

سجِّل الدخول إلى واجهة مستخدم New Edge على http://host:3001/edge، حيث host هو عنوان IP أو اسم نظام أسماء النطاقات للمضيف الذي يشغّل واجهة مستخدم New Edge.
انقر على تطوير > خوادم وكيلة لواجهة برمجة التطبيقات في شريط التنقّل الأيمن.
انقر على +الخادم الوكيل.

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

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

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

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

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

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

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

Edge

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

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

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

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

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

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

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

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

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

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

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

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

Edge

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

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

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

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

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

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

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

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

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

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

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

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

إضافة إجراءات أمان

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

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

إتاحة استخدام ميزة "مشاركة المراجع مع نطاقات خارجية" (CORS)

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

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

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

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

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

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

شعار Open API Initiative "تركز مبادرة Open API Initiative (OAI) على إنشاء وتطوير وتعزيز تنسيق وصف لواجهة برمجة التطبيقات مستقل عن المورّدين استنادًا إلى مواصفات Swagger." لمزيد من المعلومات حول مبادرة Open API، يُرجى الانتقال إلى 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 الحالية.
افتح خادم وكيل لواجهة برمجة التطبيقات في واجهة المستخدم وانقر على علامة التبويب تطوير.
في "المستكشف" (Navigator)، انقر على + بجانب نقطة نهاية الخادم الوكيل التي تريد تعديلها.
يتم فتح مربّع الحوار "مسار شرطي جديد".
انقر على من OpenAPI إذا لم يكن محدّدًا سلفًا.
إذا كانت هناك مراجع في مواصفات OpenAPI لا تتضمّن مسارًا شرطيًا مطابقًا في خادم وكيل واجهة برمجة التطبيقات، سيتم إدراجها في مربّع الحوار، كما هو موضّح في الشكل التالي.
اختَر كل المراجع التي تريد إضافة مسار شرطي إليها.
انقر على إضافة.

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

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

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

Edge

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

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

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

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

سجِّل الدخول إلى واجهة مستخدم New Edge على http://host:3001/edge، حيث host هو عنوان IP أو اسم نظام أسماء النطاقات للمضيف الذي يشغّل واجهة مستخدم New Edge.
انقر على تطوير > خوادم وكيلة لواجهة برمجة التطبيقات في شريط التنقّل الأيمن.
انقر على خادم وكيل واجهة برمجة التطبيقات في القائمة التي تريد نسخها.
انقر على المشروع > الحفظ كمراجعة جديدة.

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

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

Edge

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

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

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

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

سجِّل الدخول إلى واجهة مستخدم New Edge على http://host:3001/edge، حيث host هو عنوان IP أو اسم نظام أسماء النطاقات للمضيف الذي يشغّل واجهة مستخدم New Edge.
انقر على تطوير > خوادم وكيلة لواجهة برمجة التطبيقات في شريط التنقّل الأيمن.
انقر على خادم وكيل واجهة برمجة التطبيقات في القائمة التي تريد نسخها.
انقر على المشروع > الحفظ كخادم وكيل جديد لواجهة برمجة التطبيقات.
في مربّع الحوار "حفظ كخادم وكيل جديد لواجهة برمجة التطبيقات" (Save as New API Proxy)، أدخِل اسم خادم وكيل واجهة برمجة التطبيقات الجديد.
انقر على إضافة.

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

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

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

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