إضافة واجهة برمجة تطبيقات يدويا

ينطبق على: جميع مستويات إدارة واجهة برمجة التطبيقات

توضح هذه المقالة كيفية إضافة واجهة برمجة تطبيقات يدويا إلى Azure API Management. عندما تريد إنشاء استجابات وهمية من واجهة برمجة التطبيقات، يمكنك إنشاء واجهة برمجة تطبيقات فارغة. للحصول على معلومات حول إنشاء استجابات وهمية لواجهة برمجة التطبيقات، راجع استجابات واجهة برمجة التطبيقات الوهمية.

إذا كنت تريد استيراد واجهة برمجة تطبيقات موجودة، فشاهد قسم المحتوى المرتبط في هذه المقالة.

في هذه المقالة، ستتعلم كيفية إنشاء واجهة برمجة تطبيقات فارغة. ستحدد httpbin.org (خدمة اختبار عامة) كواجهة برمجة تطبيقات خلفية.

المتطلبات الأساسية

• أكمل التشغيل السريعلمثيل Azure APIM.

الانتقال إلى مثيل إدارة واجهة برمجة التطبيقات لديك

1. في مدخل Microsoft Azure، ابحث عن خدمات APIM وحددها:

   

2. في صفحة خدمات إدارة واجهة برمجة التطبيقات ، حدد مثيل إدارة واجهة برمجة التطبيقات:

   

إنشاء واجهة برمجة تطبيقات

1. ضمن واجهات برمجة التطبيقات في القائمة اليسرى، حدد واجهات برمجة التطبيقات.

2. حدد + Add API.

3. حدد لوحة HTTP :

   

4. أدخل عنوان URL لخدمة الويب للواجهة الخلفية (على سبيل المثال، https://httpbin.org) والإعدادات الأخرى لـ API. يتم شرح الإعدادات في استيراد ونشر البرنامج التعليمي الأول لواجهة برمجة التطبيقات.

5. حدد إنشاء.

في هذه المرحلة، ليس لديك أي عمليات في APIM التي ترتبط بالعمليات في واجهة API الخلفية. إذا قمت باستدعاء عملية يتم كشفها من خلال الخلفية ولكن ليس من خلال APIM، فستحصل على خطأ 404.

إشعار

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

إضافة عملية واختبارها

يوضح هذا القسم كيفية إضافة /get عملية لتعيينها إلى عملية الواجهة http://httpbin.org/get الخلفية.

إضافة عملية

1. تحديد واجهة برمجة التطبيقات التي أنشأتها في الخطوة السابقة.
2. حدد + إضافة عملية.
3. في عنوان URL، حدد GET وأدخل /get في مربع النص.
4. في Display name، أدخل FetchData.
5. حدد حفظ.

اختبار العملية

اختبر العملية في بوابة Azure. (يمكنك أيضا اختباره في مدخل المطور.)

1. حدد علامة التبويب الاختبار.
2. حدد FetchData.
3. حدد إرسال.

تظهر الاستجابة http://httpbin.org/get التي تنشئها العملية في قسم استجابة HTTP . إذا كنت ترغب في تحويل عملياتك، راجع تحويل واجهة برمجة التطبيقات وحمايتها.

إضافة واختبار عملية ذات معلمات

يوضح هذا القسم كيفية إضافة عملية تأخذ معلمة. في هذا المثال، يمكنك تعيين العملية إلى http://httpbin.org/status/200.

إضافة عملية

1. حدد واجهة برمجة التطبيقات التي قمت بإنشائها سابقا.
2. في علامة التبويب تصميم ، حدد + إضافة عملية.
3. في عنوان URL، حدد GET وأدخل /status/{code} في مربع النص.
4. في Display name، أدخل GetStatus.
5. حدد حفظ.

اختبار العملية

اختبر العملية في بوابة Azure. (يمكنك أيضا اختباره في مدخل المطور.)

1. حدد علامة التبويب الاختبار.

2. حدد GetStatus. في التعليمات البرمجية، أدخل 200.

3. حدد إرسال.

   تظهر الاستجابة http://httpbin.org/status/200 التي تنشئها العملية في قسم استجابة HTTP . إذا كنت ترغب في تحويل عملياتك، راجع تحويل واجهة برمجة التطبيقات وحمايتها.

إضافة واختبار عملية wildcard

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

تنبيه

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

إضافة عملية

1. حدد واجهة برمجة التطبيقات التي أنشأتها سابقا.
2. في علامة التبويب تصميم ، حدد + إضافة عملية.
3. في عنوان URL، حدد GET وأدخل /* في مربع النص.
4. في Display name، أدخل WildcardGet.
5. حدد حفظ.

اختبار العملية

اختبر العملية في بوابة Azure. (يمكنك أيضا اختباره في مدخل المطور.)

1. حدد علامة التبويب الاختبار.

2. حدد WildcardGet. جرب عمليات GET التي اختبرتها في الأقسام السابقة، أو جرب عملية GET مدعومة مختلفة.

   على سبيل المثال، في معلمات القالب، قم بتغيير القيمة بجوار اسم حرف البدل (*) إلى رؤوس. تقوم العملية بالتراجع عن رؤوس HTTP للطلب الوارد.

3. حدد إرسال.

   تظهر الاستجابة http://httpbin.org/headers التي تنشئها العملية في قسم استجابة HTTP . إذا كنت ترغب في تحويل عملياتك، راجع تحويل واجهة برمجة التطبيقات وحمايتها.

إشعار

قد يكون من المهم أن تفهم كيف يتعامل مضيف واجهة API الخلفية التي تدمجها مع مقابض مائلة على عنوان URL للعملية. لمزيد من المعلومات، راجع الأسئلة المتداولة حول APIM.

إلحاق واجهات برمجة تطبيقات أخرى

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

• مواصفات OpenAPI
• واجهة برمجة تطبيقات SOAP
• واجهة برمجة تطبيقات GraphQL
• تطبيق ويب مستضاف في Azure App Service
• دالات Azure
• تطبيقات Azure Logic
• Azure Service Fabric

إشعار

عند استيراد واجهة برمجة تطبيقات، يتم إلحاق العمليات بواجهة برمجة التطبيقات الحالية.

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

1. انتقل إلى مثيل Azure API Management في مدخل Microsoft Azure:

   

2. حدد واجهات برمجة التطبيقات في صفحة نظرة عامة على أو حدد واجهات برمجة التطبيقات >واجهات برمجة التطبيقات في القائمة على اليسار.

   

3. حدد علامة الحذف (...) بجوار واجهة برمجة التطبيقات التي تريد إلحاق واجهة برمجة تطبيقات أخرى بها.

4. حدد استيراد من القائمة المنسدلة:

   

5. حدّد خدمة لاستيراد واجهة برمجة تطبيقات منها.

المحتوى ذو الصلة

• قيود استيراد API
• استيراد مواصفة OpenAPI
• استيراد واجهة برمجة تطبيقات SOAP
• استيراد واجهة برمجة تطبيقات SOAP وتحويلها إلى REST
• استيراد واجهة برمجة تطبيقات App Service
• استيراد واجهة برمجة تطبيقات تطبيق حاوية
• استيراد واجهة برمجة تطبيقات WebSocket
• استيراد واجهة برمجة تطبيقات GraphQL
• استيراد مخطط GraphQL وإعداد محللات الحقول
• استيراد واجهة برمجة تطبيقات تطبيق دالة
• استيراد واجهة برمجة تطبيقات تطبيق منطقي
• استيراد خدمة Service Fabric
• استيراد واجهة برمجة تطبيقات Azure الذكاء الاصطناعي Foundry
• استيراد واجهة برمجة تطبيقات Azure OpenAI
• استيراد واجهة برمجة تطبيقات LLM
• استيراد واجهة برمجة تطبيقات OData
• استيراد بيانات التعريف لـ SAP OData
• استيراد واجهة برمجة تطبيقات gRPC
• تحرير واجهة برمجة تطبيقات