Share via

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

  • مقالة

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

يوضح هذا البرنامج التعليمي كيفية استيراد واجهة برمجة تطبيقات خلفية لمواصفات OpenAPI بتنسيق JSON إلى Azure API Management. توفر Microsoft واجهة برمجة التطبيقات الخلفية المستخدمة في هذا المثال، وتستضيفها على Azure في https://conferenceapi.azurewebsites.net.

بمجرد استيراد واجهة API الخلفية إلى API Management، تصبح واجهة برمجة تطبيقات API Management واجهة لواجهة API الخلفية. يمكنك تخصيص الواجهة وفقًا لاحتياجاتك في API Management دون لمس الواجهة الخلفية لواجهة برمجة التطبيقات. لمزيد من المعلومات، راجع تحويل وحماية واجهة برمجة التطبيقات الخاصة بك.

في هذا البرنامج التعليمي، تتعلم كيفية:

  • استيراد API إلى API Management
  • حدد التطبيق في مدخل Microsoft Azure

بعد الاستيراد، يمكنك إدارة API في مدخل Microsoft Azure.

لقطة شاشة لواجهة برمجة تطبيقات جديدة في APIM في المدخل.

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

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

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

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

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

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

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

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

  1. في شريط التنقل الأيسر لمثيل API Management، حدد APIs.

  2. حدد مربع OpenAPI.

  3. في النافذة Create from OpenAPI specification، حدد Full.

  4. أدخل القيم من الجدول التالي.

    يمكنك تعيين قيم واجهة برمجة التطبيقات أثناء الإنشاء أو لاحقًا بالانتقال إلى علامة التبويب Settings.

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

    الإعداد قيمة ‏‏الوصف
    مواصفات OpenAPI https://conferenceapi.azurewebsites.net?format=json تحديد خدمة الواجهة الخلفية التي تنفذ واجهة برمجة التطبيقات والعمليات التي تدعمها واجهة برمجة التطبيقات.

    يظهر عنوان URL لخدمة الواجهة الخلفية لاحقاً كعنوان URL لخدمة ويب في صفحة إعدادات واجهة برمجة التطبيقات.

    بعد الاستيراد، يمكنك إضافة عمليات أو تحريرها أو إعادة تسميتها أو حذفها في المواصفات.
    تضمين معلمات الاستعلام في قوالب التشغيل محدد (افتراضي) يحدد ما إذا كان سيتم استيراد معلمات الاستعلام المطلوبة في المواصفات كمعلمات قالب في APIM.
    ‏‫اسم العرض‬ بعد إدخال عنوان URL لمواصفات OpenAPI، تملأ APIM هذا الحقل استنادا إلى JSON. الاسم المعروض في بوابة المطورين.
    الاسم بعد إدخال عنوان URL لمواصفات OpenAPI، تملأ APIM هذا الحقل استنادا إلى JSON. اسم فريد لواجهة برمجة التطبيقات.
    الوصف بعد إدخال عنوان URL لمواصفات OpenAPI، تملأ APIM هذا الحقل استنادا إلى JSON. وصف اختياري لواجهة برمجة التطبيقات.
    مخطط URL HTTPS ما هي البروتوكولات التي يمكنها الوصول إلى واجهة برمجة التطبيقات.
    لاحقة عنوان URL لواجهة برمجة التطبيقات conference اللاحقة الملحقة بعنوان URL الأساسي لخدمة API Management. إن API Management تميز واجهات برمجة التطبيقات من خلال لاحقتها، لذلك يجب أن تكون اللاحقة فريدة لكل واجهة برمجة تطبيقات لناشر معين.
    العلامات علامات لتنظيم واجهات برمجة التطبيقات للبحث أو التجميع أو التصفية.
    المنتجات غير محدود اقتران واحد أو أكثر من واجهات برمجة التطبيقات. يأتي كل مثيل API Management ومعه نموذجان من المنتجات هما: Starter وUnlimited. يمكنك نشر واجهة برمجة تطبيقات بإقران واجهة برمجة التطبيقات بمنتج، وهو المنتج Unlimited في مثالنا الحالي.

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

    لمزيد من المعلومات حول المنتجات، راجع إنشاء منتج ونشره.
    البوابات مُدار بوابة (بوابات) API التي تعرض واجهة برمجة التطبيقات (API). هذا الحقل متاح فقط في خدمات المستوى Developer و Premium.

    تشير عبارة مُدار إلى البوابة المضمنة في خدمة API Management والمستضافة بواسطة Microsoft في Azure. لا تتوفر البوابات ذاتية الاستضافة إلا في مستويات خدمة Premium وDeveloper. يمكنك نشرها في أماكن العمل أو في السحب الأخرى.

    إذا لم يتم تحديد أي بوابات، فلن تكون واجهة برمجة التطبيقات متاحة، ولن تنجح طلبات واجهة برمجة التطبيقات.
    إصدار واجهة برمجة التطبيقات هذه؟ حدد أو قم بإلغاء التحديد لمزيد من المعلومات، راجع نشر إصدارات متعددة من API.

    إشعار

    لنشر API لعملاء API، يجب عليك ربطها بمنتج.

  5. حدد Create لإنشاء API خاصتك.

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

اختبار API الجديد في مدخل Microsoft Azure

يمكنك استدعاء عمليات API مباشرة من مدخل Microsoft Azure، والتي توفر طريقة ملائمة لعرض العمليات واختبارها. في وحدة تحكم الاختبار الخاصة بالمدخل، بشكل افتراضي، يتم استدعاء واجهات برمجة التطبيقات باستخدام مفتاح من اشتراك الوصول بالكامل المضمن. يمكنك أيضا اختبار استدعاءات واجهة برمجة التطبيقات باستخدام مفتاح اشتراك محدد النطاق لمنتج.

  1. في شريط التنقل الأيسر لمثيل API Management، حدد APIs> واجهة برمجة تطبيقات المؤتمر التجريبي.

  2. حدد علامة التبويب Test، ثم حدد GetSpeakers. الصفحة تعرض Query parameters و Headers، إن وجدت.

    في قسم طلب HTTP، يتم ملء رأس Ocp-Apim-Subscription-Key تلقائيا نيابة عنك، والذي يمكنك معرفة ما إذا كنت تحدد أيقونة "العين".

  3. حدد إرسال.

    لقطة شاشة لاختبار واجهة برمجة تطبيقات في مدخل Microsoft Azure.

    تستجيب الواجهة الخلفية بـ 200 OK وبعض البيانات.

الخطوات التالية

في هذا البرنامج التعليمي، نتعلم طريقة القيام بما يأتي:

  • استيراد API الأول الخاص بك
  • حدد التطبيق في مدخل Microsoft Azure

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

إنشاء منتج ونشره