مشاركة عبر

ابدأ باستخدام واجهة برمجة تطبيقات كتالوج Microsoft Learn باستخدام curl وVisual Studio Code

  • مقالة

ستساعدك هذه المقالة في بدء استخدام واجهة برمجة تطبيقات كتالوج Microsoft Learn مع curl وVisual Studio Code. إذا لم تكن على دراية بتفاصيل واجهة برمجة التطبيقات أو حالات الاستخدام الخاصة بها، نوصي بمراجعة مقالة نظرة عامة على ميزة واجهة برمجة تطبيقات كتالوج Learn أولا.

العملية عالية المستوى التي سنمر بها هي:

  1. الاستعلام عن واجهة برمجة تطبيقات كتالوج Learn
  2. مراجعة الاستجابة الأولية
  3. "استباق" الاستجابة
  4. تحويله إلى جدول بيانات
  5. جرب المزيد من الاستعلامات

بمجرد البدء في استخدام واجهة برمجة تطبيقات كتالوج Learn لاحتياجاتك الخاصة، قد تجد نفسك تقوم بتعديل هذه الخطوات قليلا، لمجموعة الأدوات أو الاحتياجات المطلوبة، ولكن عادة ما تكون عملية استخدامها هي نفسها لجميع حالات الاستخدام.

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

من أجل اتباع الخطوات الواردة في هذه المقالة، ستحتاج إلى curl وVisual Studio Code، وهما أداتان شائعتان ومجانيتان للاستعلام عن واجهات برمجة التطبيقات.

  • إذا كان لديك بالفعل curl وVisual Studio Code مثبتين، يمكنك التخطي إلى قسم Query the Learn Catalog API.
  • إذا لم تكن مثبتة لديك، فاتبع الإرشادات الواردة في الأقسام التالية.

تنزيل curl وإعداده

curl هي أداة سطر أوامر شائعة ومجانية مفتوحة المصدر يمكنها الاستعلام عن واجهات برمجة التطبيقات.

  1. انتقل إلى curl Download Page وقم بتنزيل الحزمة القابلة للتطبيق على بيئتك. إذا لم تكن متأكدا من الخيار الذي يجب اختياره، فاستخدم معالج curl Download.
  2. قم بتثبيت التطبيق واتبع المطالبات للتكوين. لا توجد إعدادات فريدة مطلوبة لهذه المقالة أو للاستعلام عن واجهة برمجة تطبيقات كتالوج Learn.

تنزيل Visual Studio Code وإعداده

Visual Studio Code هو محرر تعليمات برمجية مجاني وقوي تم إنشاؤه بواسطة Microsoft.

  1. انتقل إلى موقع Visual Studio Code وقم بتنزيل الحزمة القابلة للتطبيق على بيئتك.
  2. قم بتثبيت التطبيق واتبع المطالبات للتكوين.

الاستعلام عن واجهة برمجة تطبيقات كتالوج Learn

نظرا لعدم وجود مصادقة مطلوبة لاستخدام واجهة برمجة تطبيقات كتالوج Learn، يمكنك الاستعلام عن نقطة نهاية واجهة برمجة التطبيقات من أي سطر أوامر ممكن بواسطة curl. لهذا التمرين، سنستخدم المحطة الطرفية داخل Visual Studio Code.

  1. فتح Visual Studio Code.
  2. حدد Terminal في شريط التنقل العلوي.
  3. حدد محطة طرفية جديدة لفتح محطة أوامر جديدة.
  4. اختر المحطة الطرفية التي تختارها (Bash وCMD وما إلى ذلك) واكتب الأمر أدناه. يشير الأمر أدناه إلى أنه يريد استخدام curl، واستدعاء نقطة نهاية واجهة برمجة تطبيقات كتالوج Learn غير المصفاة، وسيخرج الاستجابة إلى ملف يسمى "output.json"، في الموقع المحدد في مسار الملف الموضح في المحطة الطرفية (على سبيل المثال: C:\Users\<username>):
curl https://learn.microsoft.com/api/catalog >> output.json
  1. إذا كان الطلب ناجحا، يجب أن تشاهد معلومات حول الحجم الإجمالي للملف، مثل 13.1 م (الحجم عرضة للتغيير، اعتمادا على حجم الاستجابة). إذا لم ينجح، يجب أن تتلقى خطأ.

إشعار

يجب حذف ملف output.json بعد الانتهاء من استخدامه، أو إعادة تسميته ليكون أكثر قابلية للتطبيق. إذا قمت بالاستعلام عن واجهة برمجة التطبيقات مرة أخرى باستخدام نفس اسم الملف، فسيتم إلحاق الاستجابة داخل الملف الموجود. خيار آخر هو تسمية الملف بشكل أكثر تميزا أثناء أمر الاستعلام الأولي مثل "output-1212.json" أو "output-de-de-2022-12-12.json".

مراجعة الاستجابة الأولية

الاستجابة الأولية في JSON وسيتم "تصغيرها"، ما يعني أنه تتم إزالة مسافات وخطوط وعلامات تبويب معينة لجعل الملف أصغر.

  1. في Visual Studio Code، حدد File.
  2. حدد فتح ملف.
  3. انتقل إلى ملف "output.json" الذي تم إنشاؤه كجزء من القسم السابق.

يعد هذا التصغير ممارسة قياسية ويمكن "تعديل الملف مسبقا" ليكون أكثر قابلية للقراءة بواسطة أمر في Visual Studio Code، والذي سنقوم به في القسم التالي.

إعداد الاستجابة

  1. مع فتح ملف "output.json" في Visual Studio Code، استخدم Ctrl+Shift+I.

يجب تحديث JSON للتقسيم إلى أسطر متعددة وأن يكون بتنسيق أكثر قابلية للقراءة. للحصول على معلومات حول الخصائص والقيم المختلفة داخل الاستجابة، اعرض مقالة مرجع مطور واجهة برمجة تطبيقات كتالوج Learn لقاموس البيانات.

تحويل الاستجابة إلى جدول بيانات

هناك العديد من الأشخاص الذين يستخدمون واجهة برمجة تطبيقات كتالوج Learn للمهام الفردية أو المراجعة، بدلا من دمجها في نظام. بالنسبة لحالات الاستخدام هذه، قد يكون من المفيد تحويل استجابة JSON إلى تنسيق CSV أو Excel لعرضها ك جدول بيانات. يمكنك استخدام أي أداة تحويل مفضلة، ولكن هنا يمكننا استخدام محول Flatfile Json إلى CSV.

  1. انتقل إلى: https://csvjson.com/json2csv.
  2. تحميل ملف الإخراج الخاص بك.
  3. حدد تحويل.
  4. حدد تنزيل.

إشعار

كن حذرا جدا باستخدام أدوات خارجية عبر الإنترنت لتحويل البيانات والنظر في البيانات التي تضعها فيها. في حالة واجهة برمجة تطبيقات كتالوج Learn، تكون الاستجابة متاحة للجمهور ولا تتطلب مصادقة، لذلك لا بأس من استخدام أداة عبر الإنترنت للمساعدة في تحويل التنسيق.

جرب المزيد من الاستعلامات

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

‏‏الوصف الاستعلام
جميع العناصر في واجهة برمجة تطبيقات كتالوج Learn https://learn.microsoft.com/api/catalog/
جميع الوحدات النمطية الإسبانية https://learn.microsoft.com/api/catalog/?locale=es-es&type=modules
جميع الوحدات مع درجة شعبية من 0.9 أو أعلى https://learn.microsoft.com/api/catalog/?type=modules&popularity>0.9
جميع التدريبات الأمنية للمبتدئين وعناصر الشهادات https://learn.microsoft.com/api/catalog/?level=beginner&subject=security
جميع وحدات إمكانية وصول ذوي الاحتياجات الخاصة المتقدمة مع درجة شعبية أكثر من 0.5 وتحديثها في الشهر الماضي https://learn.microsoft.com/api/catalog/?level=advanced&subject=accessibility&popularity>0.5&last_modified=gte 2022-10-01

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

نوصي بمراجعة الموارد أدناه لمساعدتك في رحلة التطوير الخاصة بك: