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

مكتمل

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

  • إنشاء مثيل APIM
  • استيراد واجهة API
  • تكوين إعدادات الواجهة الخلفية
  • اختبار واجهة برمجة التطبيقات

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

  • حساب Azure مع اشتراك نشط. إذا لم يكن لديك اشتراك بالفعل، يمكنك التسجيل للحصول على الإصدار التجريبي على https://azure.com/free .

تسجيل الدخول إلى Azure

  1. سجل الدخول إلى مدخل Microsoft Azure وافتح Cloud Shell.

    The location of Cloud Shell launch button.

  2. بعد فتح shell، تأكد من تحديد البيئة Bash.

    Selecting the Bash environment.

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

  1. دعنا نضع بعض المتغيرات لأوامر واجهة مستوى الاستدعاء لاستخدامها لتقليل مقدار إعادة الكتابة. استبدل <myLocation> بمنطقة منطقية بالنسبة لك. يجب أن يكون اسم APIM اسما فريدا عالميا، وينشئ البرنامج النصي التالي سلسلة عشوائية. استبدل <myEmail> بعنوان بريد إلكتروني يمكنك الوصول إليه.

    myApiName=az204-apim-$RANDOM
    myLocation=<myLocation>
    myEmail=<myEmail>
    
  2. قم بإنشاء مجموعة موارد. تنشئ الأوامر التالية مجموعة موارد تسمى az204-apim-rg.

    az group create --name az204-apim-rg --location $myLocation
    
  3. إنشاء مثيل APIM. يُستخدم الأمر az apim create لإنشاء المثيل. يُستخدم الخيار --sku-name Consumption لتسريع عملية المعاينة.

    az apim create -n $myApiName \
        --location $myLocation \
        --publisher-email $myEmail  \
        --resource-group az204-apim-rg \
        --publisher-name AZ204-APIM-Exercise \
        --sku-name Consumption 
    

    إشعار

    يجب أن تكتمل العملية في غضون خمس دقائق.

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

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

  1. في مدخل Azure، ابحث عن خدمات إدارة واجهة برمجة التطبيقات وحددها.

  2. على شاشة API Management حدد مثيل APIM الذي أنشأته.

  3. حدد "APIs" في جزء التنقل خدمة إدارة واجهة برمجة التطبيقات.

    Select APIs in the service navigation pane.

  4. حدد "OpenAPI" من القائمة وحدد "Full" في الإطار المنبثق.

    The OpenAPI dialog box. Fields are detailed in the following table.

    استخدم القيم من الجدول أدناه لملء النموذج. يمكنك ترك أي حقول لم تذكر قيمتها الافتراضية.

    الإعداد قيمة ‏‏الوصف
    OpenAPI Specification https://conferenceapi.azurewebsites.net?format=json مراجع الخدمة الذي يقوم بتنفيذ واجهة برمجة التطبيقات، يتم إعادة توجيه الطلبات إلى هذا العنوان. يتم ملء معظم المعلومات الضرورية في النموذج تلقائياً بعد هذا الإدخال.
    ‏‫اسم العرض‬ Demo Conference API يتم عرض هذا الاسم في مدخل المطوّر.
    الاسم واجهة برمجة تطبيقات المؤتمر التجريبي يوفّر اسماً فريداً لواجهة برمجة التطبيقات.
    الوصف يتم ملئها تلقائياً توفير وصف اختياري لواجهة برمجة التطبيقات.
    لاحقة عنوان URL لواجهة برمجة التطبيقات conference يتم إلحاق اللاحقة إلى URL الأساسي لخدمة إدارة واجهة برمجة التطبيقات. تميز APIM واجهات برمجة التطبيقات بلاحقتها، وبالتالي يجب أن تكون اللاحقة فريدة لكل واجهة برمجة تطبيقات لناشر معين.
  5. حدد إنشاء.

تكوين إعدادات الواجهة الخلفية

يتم إنشاء Demo Conference API والخلفية تحتاج إلى تحديد.

  1. حدد "Settings" في الجزء إلى اليمين وأدخل https://conferenceapi.azurewebsites.net/ في حقل الويب الخاص بـ URL.

  2. إلغاء تحديد خانة الاختيار "Subscription required".

    Specify the backend URL for the API.

  3. حدد حفظ.

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

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

  1. حدد اختبار.

    Select test in the right pane.

  2. حدد "GetSpeakers". الصفحة تعرض Query parameters و Headers، إن وجدت. Ocp-Apim-Subscription-Keyتتم التعبئة التلقائية لمفتاح الاشتراك المقترن مع واجهة برمجة التطبيقات هذه.

  3. حدد إرسال.

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

تنظيف موارد Azure

عند الانتهاء من الموارد التي أنشأتها في هذا التمرين، يمكنك استخدام الأمر أدناه لحذف مجموعة الموارد وجميع الموارد ذات الصلة.

az group delete --name az204-apim-rg