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

مقالة
06/01/2023

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

يتم استيراد واجهات برمجة التطبيقات للخلفية إلى API Management (APIM) API أو إنشاؤها وإدارتها يدويًا. الخطوات الواردة في هذا البرنامج التعليمي توضح لك كيفية القيام بما يلي:

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

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

تلميح

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

القدرة على صياغة الردود تفيد في العديد من السيناريوهات:

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

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

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

Mocked API response

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

التعرف على Azure API Management terminology.
استيعاب concept of policies in Azure API Management.
أكمل التشغيل السريع التالي:إنشاء مثيل لـ Azure API Management.

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

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

سجل الدخول إلى مدخل Microsoft Azure، ثم انتقل إلى مثيل API Management الخاص بك.
حدد تجانب APIs>+ Add API>HTTP.
في نافذة Create an HTTP API، حدد Full.
إدخال Test API لـ Display name.
تحديد Unlimited لـ Products.
تأكد من تحديد Managed لـ Gateways.
حدد إنشاء.

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

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

بوابة
Azure CLI

تحديد واجهة برمجة التطبيقات التي أنشأتها في الخطوة السابقة.
تحديد + Add Operation.

في نافذة Frontend، إدخال القيم التالية.

نافذة Frontend

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

تحديد علامة تبويب Responses الموجودة أسفل حقول عنوان URL واسم العرض والوصف. إدخال الإعدادات في علامة التبويب هذه لتحديد أكواد حالة الاستجابة وأنواع المحتوى والأمثلة والمخططات.
تحديد + Add response، وتحديد 200 OK من القائمة.
تحت عنوان Representations على اليسار، تحديد + Add representation.
إدخال application/json في مربع البحث وتحديد نوع محتوى application/json.
في مربع نص Sample، أدخل { "sampleField" : "test" }.
حدد حفظ.

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

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

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

استخدم بيئة Bash في Azure Cloud Shell. لمزيد من المعلومات، راجع التشغيل السريع ل Bash في Azure Cloud Shell.
إذا كنت تفضل تشغيل أوامر مرجع CLI محلياً قم بتثبيت CLI Azure. إذا كنت تعمل على نظام تشغيل Windows أو macOS، ففكر في تشغيل Azure CLI في حاوية Docker. لمزيد من المعلومات، راجع كيفية تشغيل Azure CLI في حاوية Docker.
- إذا كنت تستخدم تثبيت محلي، يُرجى تسجيل الدخول إلى Azure CLI مستخدمًا أمر az login. لإنهاء عملية المصادقة، اتبع الخطوات المعروضة في جهازك. للحصول على خيارات أخرى لتسجيل دخول، راجع تسجيل الدخول باستخدام Azure CLI.
- عندما يُطلب منك، قم بتثبيت ملحق Azure CLI عند الاستخدام لأول مرة. لمزيد من المعلومات بشأن الامتدادات، راجع استخدام امتدادات مع Azure CLI.
- يُرجى تشغيل إصدار az للوصول إلى الإصدار والمكتبات التابعة التي تم تثبيتها. للتحديث لآخر إصدار، يُرجى تشغيل تحديث az.

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

az apim api operation create --resource-group apim-hello-word-resource-group \
    --display-name "Test call" --api-id test-api --method GET \
    --url-template /test --service-name apim-hello-world

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

az apim api operation list --resource-group apim-hello-word-resource-group \
    --api-id test-api --service-name apim-hello-world --output table

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

az apim api operation delete --resource-group apim-hello-word-resource-group \
    --api-id test-api --operation-id 00000000000000000000000000000000 \
    --service-name apim-hello-world

الاحتفاظ بهذه العملية لاستخدامها في بقية هذه المقالة.

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

تحديد API التي أنشأتها في Create a test API.
في النافذة اليمنى، يجب التأكد من تحديد علامة تبويب Design.
تحديد عملية الاختبار التي أضفتها.
في نافذة Inbound processing، تحديد + Add policy.
حدد Mock responses من المعرض.
في مربع النص API Management response، يلزم كتابة 200 OK, application/json. يشير هذا التحديد إلى أن واجهة برمجة التطبيقات (API) الخاصة بك يجب أن تُرجع عينة الاستجابة التي حددتها في القسم السابق.
حدد حفظ.

تلميح

يتم تمكين عرض شريط أصفر مع النص Mocking. يشير ذلك إلى أن الاستجابات التي تُرجع من API Management تُستنسخ من خلال mocking policy ولا تُنتج بواسطة الخلفية.

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

تحديد API التي أنشأتها في Create a test API.
حدد علامة التبويب الاختبار.
تأكد من تحديد واجهة برمجة تطبيقات Test call، ثم حدد Send لإجراء استدعاء اختبار.
تعرض HTTP response الـ JSON المُقدم كنموذج في القسم الأول من البرنامج التعليمي.