تمرين - استخدام ملحقات OpenAPI

مكتمل

في هذا التمرين، ستقوم بتكوين ملحقات OpenAPI فِي موصل Contoso Invoicing المخصص. ستقوم بتنفيذ الملحقات التالية:

  • اختبار الاتصال - للتحقق مِن صحة مفتاح API الذي تم إدخاله.

  • القيم الديناميكية - لجعل إدخال معرف نوع الفاتورة قائمة منسدلة مِن القيم مِن API.

  • مخطط ديناميكي - لإظهار المعلمات الصالحة فقط لنوع الفاتورة المحدد.

هام

استخدم بيئة اختبار مع توفير Microsoft Dataverse. وإذا لم يتوفر لديك، فيمكنك الاشتراك فِي خطة المجتمع.

ملاحظة

قم بتنزيل الملف التالي إلَى الكمبيوتر المحلي لديك لإكمال مشغّلات Contoso Invoicing. حدّد الزر "تنزيل" فِي منتصف الشاشة عَلى اليمين.

الهامة 1: استيراد حل

في هذه الهامة، ستستورد حلاً غير مُدار يحتوي عَلى موصل Contoso Invoicing مخصص ثم تختبر هذا الموصل. وستستخدم هذا الموصل لإكمال المهام الموجودة فِي هذا التمرين.

  1. انتقل إلَى Power Apps Maker Portal وتأكد مِن وجودك فِي البيئة الصحيحة.

  2. حدّد حل > استيراد الحلول.

  3. حدّد استعراض.

  4. حدّد الحل ContosoInvoicingExtensions_1_0_0_0.zip ثم حدّد فتح.

  5. حدّد التالي.

  6. حدّد استيراد ثم انتظر حتى يكتمل الاستيراد. من المفترض أن تتلقى رسالة نجاح بعد اكتمال الاستيراد.

  7. حدّد نشر جميع التخصيصات وانتظر حتى اكتمال النشر.

  8. حدّد Contoso Invoicing - Extensions الذي قمت باستيراده.

    من المفترض أن ترى مكون الموصل المخصص Contoso invoicing - الملحقات.

  9. حدّد الموصل Contoso Invoicing - الملحقات ثم حدّد تحرير.

  10. ابدأ نافذة مستعرض جديدة، ثم انتقل إلَى Contoso Invoicing.

  11. حدّد ارتباط مفتاح API.

  12. انسخ مفتاح API. احفظ هذا المفتاح فِي المفكرة، سوف تحتاجه للمهام المستقبلية.

  13. ارجع إلَى الموصل، وحدّد علامة التبويب اختبار، ثم حدّد + اتصال جديد.

  14. الصق المفتاح الذي قمت بنسخه فِي الحقل مفتاح API، ثم حدّد إنشاء اتصال.

  15. حدّد تحديث الاتصالات.

  16. مرر لأسفل إلَى قسم العمليات وحدّد ListInvoiceTypes، ثم حدّد اختبار العملية.

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

  17. لا تخرج مِن هذه الصفحة.

الهامة 2: إضافة ملحق اختبار الاتصال

في هذه الهامة، ستضيف ملحق اختبار الاتصال:

  1. قم بتشغيل مفتاح التبديل محرر Swagger.

  2. أضف الجزء التالي بعد إنتاج: [] ثم حدّد تحديث الموصل. تأكد مِن تطابق المسافة البادئة للنص مع الصورة التالية.

    x-ms-capabilities:
       testConnection:
         operationId: ListInvoices
         parameters: {}
    

    تأكد مِن أن المسافة البادئة تبدو مثل الصورة أدناه.

  3. حدّد + اتصال جديد مرة أخرى.

  4. أدخل اسمك أو قيمة عشوائية أخرى لمفتاح API ثم حدّد إنشاء اتصال.

    يجب أن يفشل إنشاء الاتصال.

  5. قم بتوفير مفتاح API الذي قمت بنسخه فِي الهامة 1 فِي الحقل مفتاح API، ثم حدّد إنشاء اتصال.

    يجب أن ينجح إنشاء الاتصال الآن.

  6. لا تخرج مِن هذه الصفحة.

الهامة 3: تكوين القيم الديناميكية لمعرف نوع الفاتورة

في هذه الهامة ستقوم بتكوين القيم الديناميكية لمعرف نوع الفاتورة:

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

  2. حدّد AddInvoice مِن قسم الإجراءات.

  3. مرّر لأسفل، وحدّد زر علامة الحذف (Chevron) لمعلمة typeId، ثم حدّد تحرير.

  4. أدخل نوع الفاتورة فِي الملخص، وأدخل 1 فِي القيمة الافتراضية، ثم حدّد نعم فِي مطلوب.

  5. مرر لأسفل وحدّد ديناميكي لـ نوع Dropdown.

  6. حدّد ListInvoiceTypes لـ معرف العملية، وحدّد typeId لـ القيمة، ثم حدّد name لـ اسم عرض القيمة.

  7. حدّد تحديث الموصل.

  8. قم بتشغيل مفتاح التبديل محرر Swagger.

  9. إذا ظهرت لك أخطاء فِي مفتاح التجزئة، فأغلق علامة تبويب مستعرض الموصل، ثم أعد فتحها فِي وضع التحرير.

  10. حدّد موقع AddInvoice وتحقق لمعرفة ما إذا كان قد تمت إضافة x-ms-dynamic-values.

  11. لا تخرج مِن هذه الصفحة.

الهامة 4: تكوين ملحق المخطط الديناميكي

في هذه الهامة، ستقوم بتكوين ملحق المخطط الديناميكي:

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

  2. حدّد العملية GetInvoiceSchema ثم حدّد اختبار العملية.

  3. راجع الاستجابة. هذه الاستجابة هي ما تحتاج واجهة API إلَى رجوعه للسماح بتكوين المخطط الديناميكي.

  4. قم بتشغيل مفتاح التبديل محرر Swagger.

  5. حدّد موقع سطر CreateInvoiceRequest وأضف نص Swagger التالي بدلاً مِن سطر invoice.

    Invoice:

    x-ms-dynamic-properties:

    operationId: GetInvoiceSchema

    المعلمات:

    typeId: {parameterReference: typeId}

    قبل:

    بعد:

    تأكد مِن تطابق المسافات البادئة مع الصورة التالية.

  6. قم بإيقاف تشغيل مفتاح التبديل محرر Swagger.

  7. حدّد علامة التبويب التعريف.

  8. حدّد الإجراء GetInvoiceSchema ثم حدّد داخلي لـ الرؤية.

  9. حدّد تحديث الموصل.

الهامة 5: اختبار الموصل

في هذه الهامة، ستختبر الموصل:

  1. انتقل إلَى Power Automate وتأكد مِن أنك فِي البيئة الصحيحة.

  2. حدّد الحلول ثم افتح حل Contoso Invoicing - Extensions.

  3. حدّد + جديد ثم حدّد التشغيل التلقائي > سير عمل السحابة > فوري.

  4. أدخل بيانات التعريف الديناميكية واسم التدفق وحدّد تشغيل تدفق يدوياً للمشغل ثم حدّد إنشاء.

  5. حدّد + خطوة جديدة.

  6. حدّد علامة التبويب مخصص ثم حدّد Contoso Invoicing - Extensions.

  7. حدّد AddInvoice للإجراء.

  8. أدخل اتصالي للاسم، وأدخل اسمك لـ مفتاح API، ثم حدّد إنشاء. يجب أن يفشل اختبار الاتصال.

  1. قم بتوفير مفتاح API الذي قمت بنسخه فِي الهامة 1 فِي الحقل مفتاح API، ثم حدّد إنشاء مرة أخرى.

    يجب إنشاء الاتصال بنجاح.

  2. في القائمة المنسدلة نوع الفاتورة، حدّد أمر شراء.

    يجب أن يكون الحقل أمر شراء مرئياً الآن.

  3. قم بتغيير نوع الفاتورة إلَى ليس أمر شراء.

    يجب ألا يكون الحقل أمر شراء مرئياً بعد الآن.

  4. احفظ التدفق.