البرنامج التعليمي: استجابات Mock API

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

يتم استيراد واجهات برمجة التطبيقات الخلفية إلى واجهة برمجة تطبيقات Azure API Management أو إنشاؤها وإدارتها يدويا. تصف الخطوات الواردة في هذا البرنامج التعليمي كيفية:

• استخدم API Management لإنشاء واجهة برمجة تطبيقات HTTP فارغة.
• إدارة واجهة برمجة تطبيقات HTTP يدويا.
• تعيين نهج على واجهة برمجة تطبيقات بحيث تقوم بإرجاع استجابة وهمية.

تمكن هذه الطريقة المطورين من مواصلة تنفيذ واختبار مثيل APIM حتى إذا لم تكن الواجهة الخلفية متاحة لإرسال استجابات حقيقية.

تلميح

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

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

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

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

• إنشاء API تجريبي
• إضافة عملية إلى اختبار API
• تفعيل استجابة الاستنساخ
• اختبار API المُستنسخة

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

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

إنشاء API تجريبي

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

1. سجل الدخول إلى مدخل Microsoft Azure، ثم انتقل إلى مثيل API Management الخاص بك.

2. حدد APIs>+ Add API>HTTP tile:

   

3. في نافذة Create an HTTP API، حدد Full.

4. في Display name، أدخل Test API.

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

6. في Gateways، حدد Managed إذا كان هذا الخيار متوفرا. (هذا الخيار هو avaiable فقط في مستويات خدمة معينة.)

7. حدد إنشاء.

   

إضافة عملية إلى اختبار API

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

بوابة

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

2. تحديد + Add Operation.

3. في نافذة الواجهة الأمامية ، أدخل القيم التالية:

   الإعداد	قيمة	‏‏الوصف
   ‏‫اسم العرض‬	Test call	الاسم المعروض في مدخل المطور.
   عنوان URL (المربع الأول)	GET	تحديد أحد أفعال "HTTP" المحددة مسبقاً.
   URL (المربع الثاني)	/test	مسار "URL" لـ API.
   الوصف		وصف اختياري للعملية. يوفر وثائق في مدخل المطور للمطورين الذين يستخدمون واجهة برمجة التطبيقات.

   

4. حدد علامة التبويب الردود ، الموجودة ضمن مربعات URLواسم العرضوالوصف . ستدخل القيم في علامة التبويب هذه لتعريف رموز حالة الاستجابة وأنواع المحتويات والأمثلة والمخططات.

5. حدد + Add response، ثم حدد 200 OK من القائمة.

   

6. في قسم التمثيلات ، حدد + إضافة تمثيل.

7. أدخل application/json في مربع البحث ثم حدد نوع محتوى application/json .

8. في المربع عينة ، أدخل { "sampleField" : "test" }.

9. حدد حفظ.

   

على الرغم من أنه غير مطلوب لهذا المثال، يمكنك تكوين المزيد من الإعدادات لعملية API على علامات تبويب أخرى، كما هو موضح في الجدول التالي:

علامة التبويب	‏‏الوصف
استفسار	إضافة معلمات الاستعلام. بالإضافة إلى توفير اسم ووصف، يمكن أيضًا توفير القيم التي عُينت لمعامل الاستعلام. يمكنك وضع علامة على إحدى القيم على أنها افتراضية (اختياري).
Request	تحديد أنواع محتوى الطلب والأمثلة والمخططات.

Azure CLI

للبدء في استخدام Azure CLI:

• استخدم بيئة Bash في Azure Cloud Shell. لمزيد من المعلومات، راجع بدء استخدام Azure Cloud Shell.

  

• إذا كنت تفضل تشغيل أوامر مرجع CLI محلياً قم بتثبيت CLI Azure. إذا كنت تعمل على نظام تشغيل Windows أو macOS، ففكر في تشغيل Azure CLI في حاوية Docker. لمزيد من المعلومات، راجع كيفية تشغيل Azure CLI في حاوية Docker.

  • إذا كنت تستخدم تثبيت محلي، يُرجى تسجيل الدخول إلى Azure CLI مستخدمًا أمر az login. لإنهاء عملية المصادقة، اتبع الخطوات المعروضة في جهازك. للحصول على خيارات تسجيل الدخول الأخرى، راجع المصادقة على Azure باستخدام Azure CLI.

  • عندما يُطلب منك، قم بتثبيت ملحق Azure CLI عند الاستخدام لأول مرة. لمزيد من المعلومات حول الملحقات، راجع استخدام الملحقات وإدارتها باستخدام Azure CLI.

  • يُرجى تشغيل إصدار az للوصول إلى الإصدار والمكتبات التابعة التي تم تثبيتها. للتحديث لآخر إصدار، يُرجى تشغيل تحديث az.

لإضافة عملية إلى اختبار API الخاص بك، يلزم تشغيل الأمر az apim api operation create:

az apim api operation create --resource-group <resource-group> \
    --display-name "Test call" --api-id test-api --method GET \
    --url-template /test --service-name <API-management-service-name> 

تشغيل الأمر az apim api operation list لمشاهدة جميع العمليات الخاصة بـ API:

az apim api operation list --resource-group <resource-group-name> \
    --api-id test-api --service-name <API-management-service-name> --output table

الاحتفاظ بهذه العملية لاستخدامها في بقية هذه المقالة. إذا كنت ترغب في إزالة عملية، يمكنك استخدام الأمر az apim api operation delete . احصل على معرف العملية من الأمر السابق.

az apim api operation delete --resource-group <resource-group-name> \
    --api-id test-api --operation-id <ID> \
    --service-name <API-management-service-name>

تفعيل استجابة الاستنساخ

1. تحديد API التي أنشأتها في Create a test API.

2. تأكد من تحديد علامة التبويب تصميم .

3. تحديد عملية الاختبار التي أضفتها.

4. في القسم المعالجة الواردة، حدد + Add policy.

   

5. حدد تجانب الاستجابات الوهمية من المعرض:

   

6. تأكد من ظهور 200 OK، application/json في مربع استجابة APIM . يشير هذا التحديد إلى أن واجهة برمجة التطبيقات يجب أن ترجع نموذج الاستجابة الذي قمت بتعريفه في القسم السابق.

   

7. حدد حفظ.

   تلميح

   يظهر شريط أصفر يعرض النص تم تمكين "التقليد ". تشير هذه الرسالة إلى أن الاستجابات التي تم إرجاعها من API Management يسخر منها نهج الاستنساخ ولا يتم إنتاجها بواسطة الخلفية.

اختبار API المُستنسخة

1. تحديد API التي أنشأتها في Create a test API.

2. في علامة التبويب Test ، تأكد من تحديد Test call API، ثم حدد Send لإجراء مكالمة اختبار:

   

3. تعرض استجابة HTTP JSON المقدمة كعينة في القسم الأول من البرنامج التعليمي:

   

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

انتقل إلى البرنامج التعليمي التالي:

تحويل واجهة برمجة تطبيقات منشورة وحمايتها