أفضل الممارسات لاستخدام واجهة برمجة تطبيقات كتالوج Microsoft Learn
توضح هذه المقالة أفضل الممارسات لاستخدام واجهة برمجة تطبيقات كتالوج Learn.
فهم شروط الخدمة
على الرغم من أن واجهة برمجة تطبيقات كتالوج Learn متاحة للجمهور ومجانية للاستخدام، فإن المستخدمين يخضعون لشروط استخدام واجهة برمجة تطبيقات Microsoft. قراءة وفهم شروط استخدام واجهة برمجة التطبيقات قبل استخدام واجهة برمجة تطبيقات كتالوج Learn وقبل تضمين الإخراج في أي بيئة إنتاج.
فهم قيود واجهة برمجة تطبيقات كتالوج Learn
راجع القيود في مقالة نظرة عامة على ميزة واجهة برمجة تطبيقات كتالوج Learn.
فهم con learn وضع الخيمة l
لاستخدام استجابة واجهة برمجة تطبيقات كتالوج Learn بشكل فعال، من المهم فهم أنواع المحتوى المتوفر في Microsoft Learn وعلاقاتها مع بعضها البعض. راجع مقالة Learn con وضع الخيمة l للحصول على مزيد من المعلومات.
لا سيما:
- يرمز UID إلى المعرف الفريد وهو فريد لكل كائن محتوى. إذا تغير UID، حتى إذا بقي العنوان أو بيانات التعريف الأخرى كما هي، يعتبر المحتوى كائنا جديدا.
- الوحدات النمطية هي العنصر الأساسي داخل كتالوج تدريب Learn. إنهم جميعا قادرون على الوقوف بمفردهم، بمعنى أنهم يعلمون سيناريو أو مفهوما من طرف إلى طرف داخلهم ولا يحتاجون إلى أخذ وحدات المتطلبات الأساسية. بالنسبة للبعض، هذا هو الأمر وهو ليس جزءا من مسار التعلم. بالنسبة للآخرين، يتم تجميعها معا في مسار تعلم واحد أو أكثر يأخذ المستخدم من خلال بناء مفاهيم أكثر تقدما. لا يجب أن تكون الوحدة النمطية جزءا من مسار التعلم، أو يمكن أن تكون جزءا من واحد أو أكثر.
- لا تتم كتابة الوحدات كمحتوى مستقل. الغرض منها أن يتم أخذها بترتيب محدد للوحدة النمطية. لهذا السبب، نقوم بتضمين الارتباط إلى صفحة تفاصيل الوحدة التدريبية والوحدة الأولى حتى يمكن للمستخدمين البدء من هناك ومتابعة المحتوى.
فهم كيفية عمل الترجمة في Learn وكيف ينعكس المحتوى المترجم في إخراج واجهة برمجة التطبيقات
يدعم Microsoft Learn أكثر من 65 موقعا محليا على الموقع ويتم ترجمة الكثير من المحتوى إلى هذه الإعدادات المحلية. نهدف إلى جعل المحتوى متوفرا بجميع اللغات التي تتوفر بها المنتجات التي يتم تدريسها في المحتوى، ولكن ليس كل التجارب المحلية تحتوي على محتوى مترجم.
عندما لا يحتوي سجل الإعدادات المحلية على الترجمة المقترنة المتوفرة، فإن المحتوى الموجود على الموقع واستجابة واجهة برمجة التطبيقات "يعودان" إلى اللغة الإنجليزية كإعداد افتراضي. في إخراج واجهة برمجة التطبيقات، ترى بيانات تعريف اللغة الإنجليزية في استجابات محلية أخرى عند حدوث العودة. ومع ذلك، لا يزال عنوان URL للمحتوى يشير إلى الإعدادات المحلية، على الرغم من أن المحتوى الرئيسي قد يعود مرة أخرى والسبب هو السماح للمستخدم بالتنقل في الموقع في تلك الإعدادات المحلية (الذي يعرض العنوان/التذييل المترجم، وأي ارتباط آخر يحتوي على ترجمة متوفرة).
عند نشر التحديثات على المحتوى الإنجليزي، تعمل مسارات الترجمة لدينا على تحديث الإصدارات المترجمة في أقرب وقت ممكن - عادة في غضون أيام قليلة من التغيير الأصلي.
يمكنك مشاهدة قائمة كاملة بالمواقع المحلية المدعومة في تذييل موقع Microsoft Learn (حدد اللغة التي تعرضها). يمكن الاستعلام عن كل من هذه الإعدادات المحلية باستخدام واجهة برمجة تطبيقات كتالوج Learn باستخدام عامل التصفية locale .
سجلات إكمال محتوى التدريب الخاصة بنا غير محددة محليا، مما يعني أننا لا نميز الإصدارات المترجمة من المحتوى ككائنات منفصلة في سجلات إكمال تدريب المستخدم. بغض النظر عن اللغة التي يكمل المستخدم التدريب بها، فإنه يتلقى رصيدا للعنصر العام، ولا نقوم بتخزين مرجع إلى اللغة التي تم إكمالها بها. يعني هذا الإكمال غير المحدد للغات المحلية أنه إذا قمت بتنفيذ واجهة برمجة تطبيقات كتالوج Learn في تجربة التعلم الخاصة بك، فأنت بحاجة إلى أخذها في الاعتبار، وإذا قمت بتحميل عناصر المحتوى في ككائنات منفصلة، فنفذ تكافؤا بينها بحيث بغض النظر عن اللغة التي يكمل المستخدم التدريب بها، يحصل على رصيد له باللغات الأخرى وليس عليه إعادة أخذه.
فهم كيفية عمل إصدار المحتوى في Learn وكيف ينعكس في إخراج واجهة برمجة التطبيقات
وتجدر الإشارة إلى أنه يتم تحديث المحتوى طوال الوقت. ننشر التحديثات المتوفرة مرتين في اليوم. قد تكون إما ثانوية، مثل تغييرات النص الثانوية، أو رئيسية، مثل المراجعات الرئيسية أو الإضافات أو عمليات الحذف. بشكل عام، تتم إدارة محفظة المحتوى كمشروع ضخم ومحكم للغاية مفتوح المصدر مع الآلاف من المساهمين، وعلى هذا النحو، تحدث التغييرات في كل وقت. إذا كنت تستخدم واجهة برمجة تطبيقات كتالوج Learn في نظام الإنتاج الخاص بك، يجب أن تكون على دراية بذلك وأن يكون نظامك قادرا على التعامل معها.
عند إضافة كائنات محتوى جديدة، تظهر ككائن جديد (تم تعريفه بواسطة UID) في الاستجابة. عند تعديل المحتوى، يمكنك معرفة ذلك استنادا إلى قيمته last_modified. عند حذف المحتوى، تتم إزالة كائن المحتوى من الاستجابة. على الرغم من وجود تأخير طفيف في بعض الأحيان في تحديث المحتوى في استجابة واجهة برمجة التطبيقات، عندما يتبع المستخدم عنوان URL للمحتوى، سيرى دائما أحدث المعلومات. في حالة الحذف، سيعاد توجيه عنوان URL القديم إلى المحتوى أو التجربة الجديدة، أو إلى الخيار الأفضل التالي.
لا توجد مراجع لإصدارات المحتوى في هذا الوقت بعد last_modified التاريخ.
تحديث البيانات بانتظام
إذا كنت تستخدم معلومات الكتالوج من واجهة برمجة تطبيقات كتالوج Learn لدعم عمليات عملك، أو عرضها للعملاء كجزء من تجربة موقعك، فتأكد من تحديث المحتوى مرة واحدة على الأقل في اليوم.
وتجدر الإشارة إلى أنه يتم تحديث المحتوى طوال الوقت. ننشر التحديثات المتوفرة مرتين في اليوم. قد تكون إما ثانوية، مثل تغييرات النص الثانوية، أو رئيسية، مثل المراجعات الرئيسية أو الإضافات أو عمليات الحذف. بشكل عام، تتم إدارة محفظة المحتوى كمشروع ضخم ومحكم للغاية مفتوح المصدر مع الآلاف من المساهمين، وعلى هذا النحو، تحدث التغييرات في كل وقت. إذا كنت تستخدم واجهة برمجة تطبيقات كتالوج Learn في نظام الإنتاج الخاص بك، يجب أن تكون على دراية بذلك وأن يكون نظامك قادرا على التعامل معها.
مراجعة التوصيات المتعلقة بوثائق المطور
تحتوي وثائق مطور واجهة برمجة تطبيقات كتالوج Learn على قائمة كاملة بالبيانات المقدمة كجزء من الاستجابة، وتوصيات حول كيفية استخدام كل حقل لدعم تجارب التعلم الرائعة.
فهم منطق الاستعلام
هناك العديد من عوامل التصفية المتاحة للاستخدام لتصفية الاستجابة مسبقا، بحيث تحصل فقط على ما تبحث عنه ويمكنك التعامل مع أحجام الملفات الأصغر. يمكنك مشاهدة القائمة الكاملة لعوامل تصفية الاستعلام في مقالة مرجع مطور واجهة برمجة تطبيقات كتالوج Learn. بشكل ملحوظ، تحتاج إلى تشكيل الاستعلام بشكل صحيح وإذا كنت تستخدم أكثر من معلمة استعلام واحدة في الطلب، يتم تقييم الاستعلام باستخدام عامل التشغيل AND.
الخطوات التالية
لمزيد من المعلومات لدعمك في واجهة برمجة تطبيقات كتالوج Learn، راجع المقالات التالية: