البرنامج التعليمي: تعريف بيانات التعريف المخصصة
في هذا البرنامج التعليمي، حدد بيانات التعريف المخصصة لمساعدتك على تنظيم واجهات برمجة التطبيقات والمعلومات الأخرى في مركز API الخاص بك. استخدم بيانات التعريف المخصصة والمضمنة للبحث والتصفية وفرض معايير الحوكمة في مؤسستك.
للحصول على معلومات خلفية حول بيانات التعريف في Azure API Center، راجع:
في هذا البرنامج التعليمي، ستتعلم كيفية استخدام المدخل من أجل:
- تعريف بيانات التعريف المخصصة في مركز واجهة برمجة التطبيقات
- عرض مخطط بيانات التعريف
المتطلبات الأساسية
- مركز API في اشتراك Azure الخاص بك. إذا لم تكن قد أنشأت واحدا بالفعل، فشاهد التشغيل السريع: إنشاء مركز واجهة برمجة التطبيقات.
تعريف بيانات التعريف
هنا يمكنك تحديد مثالين لبيانات التعريف المخصصة: خط العمل والواجهة العامة؛ إذا كنت تفضل ذلك، فحدد بيانات التعريف الأخرى الخاصة بك. عند إضافة أو تحديث واجهات برمجة التطبيقات والمعلومات الأخرى في المخزون الخاص بك، ستقوم بتعيين قيم مخصصة وأي بيانات تعريف مضمنة شائعة.
هام
لا تقم بتضمين أي معلومات حساسة أو سرية أو شخصية في عناوين (أسماء) بيانات التعريف التي تحددها. تظهر هذه العناوين في سجلات المراقبة التي تستخدمها Microsoft لتحسين وظائف الخدمة. ومع ذلك، فإن تفاصيل وقيم بيانات التعريف الأخرى هي بيانات العميل المحمية.
في مدخل Microsoft Azure، انتقل إلى مركز واجهة برمجة التطبيقات.
في القائمة اليسرى، ضمن Assets، حدد Metadata > + New metadata.
في علامة التبويب تفاصيل ، أدخل معلومات حول بيانات التعريف.
في العنوان، أدخل خط العمل.
اختياريا، أدخل Description.
حدد "type Predefined choices " وأدخل خيارات مثل Marketing و Finance و IT و Sales وما إلى ذلك. تمكين السماح بتحديد قيم متعددة اختياريا. حدد التالي.
في علامة التبويب الواجبات ، حدد مطلوب لواجهات برمجة التطبيقات. حدد اختياري للنشر والبيئات. (ستضيف هذه الكيانات في البرامج التعليمية اللاحقة.) حدد التالي.
في علامة التبويب Review + create ، راجع الإعدادات وحدد Create.
تتم إضافة بيانات التعريف إلى القائمة في صفحة بيانات التعريف .
حدد + New metadata لإضافة مثال آخر.
في علامة التبويب تفاصيل ، أدخل معلومات حول بيانات التعريف.
في العنوان، أدخل Public-facing.
حدد type Boolean.
في علامة التبويب الواجبات ، حدد مطلوب لواجهات برمجة التطبيقات. حدد Not applicable for Deployments and Environments.
في علامة التبويب Review + create ، راجع الإعدادات وحدد Create.
تتم إضافة بيانات التعريف إلى القائمة.
عرض مخطط بيانات التعريف
يمكنك عرض وتنزيل مخطط JSON لبيانات التعريف المحددة في مركز API الخاص بك. يتضمن المخطط بيانات تعريف مضمنة ومخصصة.
في القائمة اليمنى، ضمن Assets، حدد Metadata > View metadata schema.
حدد View metadata schema > APIs لمشاهدة مخطط بيانات التعريف لواجهات برمجة التطبيقات، والذي يتضمن بيانات التعريف المضمنة والمخصصة. يمكنك أيضا عرض مخطط بيانات التعريف المعرفة للتوزيعات والبيئات في مركز API الخاص بك.
الخطوات التالية
في هذا البرنامج التعليمي، تعلمت كيفية استخدام المدخل من أجل:
- تعريف بيانات التعريف المخصصة في مركز واجهة برمجة التطبيقات
- عرض مخطط بيانات التعريف
الآن بعد أن قمت بإعداد مخطط بيانات التعريف، أضف واجهات برمجة التطبيقات إلى المخزون في مركز API الخاص بك.