เริ่มต้นใช้งานแค็ตตาล็อก API Microsoft Learn โดยใช้ curl และ Visual Studio Code
บทความนี้จะช่วยคุณในการเริ่มต้นใช้งาน API แค็ตตาล็อก Microsoft Learn ด้วย curl และ Visual Studio Code หากคุณไม่คุ้นเคยกับรายละเอียดของ API หรือกรณีการใช้งาน เราขอแนะนําให้คุณอ่าน บทความ ภาพรวมคุณลักษณะแค็ตตาล็อกการเรียนรู้ API ก่อน
กระบวนการระดับสูงที่เราจะแนะนําคือ:
- คิวรีแค็ตตาล็อก API การเรียนรู้
- ตรวจสอบคําตอบเริ่มต้น
- "ยืนยัน" คําตอบ
- แปลงให้เป็นสเปรดชีต
- ลองใช้คิวรีเพิ่มเติม
เมื่อคุณเริ่มใช้ Learn Catalog API สําหรับความต้องการของคุณเอง คุณอาจพบว่าตัวเองปรับเปลี่ยนขั้นตอนเหล่านี้เล็กน้อยสําหรับชุดเครื่องมือหรือความต้องการที่คุณต้องการ แต่โดยทั่วไปแล้วกระบวนการจะใช้จะเหมือนกันสําหรับกรณีการใช้งานทั้งหมด
ข้อกำหนดเบื้องต้น
เพื่อทําตามขั้นตอนในบทความนี้ คุณจะต้องมี curl และ Visual Studio Code เครื่องมือฟรียอดนิยมสองตัวสําหรับการคิวรี API
- ถ้าคุณติดตั้ง curl และ Visual Studio Code แล้ว คุณสามารถข้ามไปยังส่วน Query แค็ตตาล็อก API Learn ได้
- ถ้าคุณไม่ได้ติดตั้งโปรแกรมเหล่านั้นไว้ ให้ทําตามคําแนะนําในส่วนต่อไปนี้
ดาวน์โหลดและตั้งค่า curl
curl คือเครื่องมือบรรทัดคําสั่งที่ได้รับความนิยมฟรีโอเพนซอร์สและสามารถคิวรี API ได้
- ไปที่ หน้าดาวน์โหลด curl และดาวน์โหลดแพคเกจที่เหมาะสมกับสภาพแวดล้อมของคุณ ถ้าคุณไม่แน่ใจว่าควรเลือกอะไร ให้ใช้ตัวช่วยสร้างการดาวน์โหลด curl
- ติดตั้งแอปพลิเคชันและทําตามพร้อมท์เพื่อกําหนดค่า ไม่จําเป็นต้องมีการตั้งค่าที่ไม่ซ้ํากันสําหรับบทความนี้หรือสําหรับการคิวรีแค็ตตาล็อก API Learn
ดาวน์โหลดและตั้งค่า Visual Studio Code
Visual Studio Code เป็นตัวแก้ไขโค้ดฟรีและมีประสิทธิภาพที่สร้างขึ้นโดย Microsoft
- ไปที่ ไซต์ Visual Studio Code และดาวน์โหลดแพคเกจที่เหมาะสมกับสภาพแวดล้อมของคุณ
- ติดตั้งแอปพลิเคชันและทําตามพร้อมท์เพื่อกําหนดค่า
คิวรีแค็ตตาล็อก API การเรียนรู้
เนื่องจากไม่มีการรับรองความถูกต้องเพื่อใช้ Learn Catalog API คุณสามารถคิวรีจุดสิ้นสุด API จากบรรทัดคําสั่งใดก็ตามที่เปิดใช้งาน curl ได้ สําหรับแบบฝึกหัดนี้ เราจะใช้เทอร์มินัลภายในรหัส Visual Studio
- เปิด Visual Studio Code
- เลือกเทอร์มินัลในการนําทางด้านบน
- เลือกเทอร์มินัลใหม่เพื่อเปิดเทอร์มินัลคําสั่งใหม่
- เลือกเทอร์มินัลของตัวเลือก (Bash, CMD และอื่น ๆ) และพิมพ์คําสั่งด้านล่าง คําสั่งด้านล่างระบุว่าต้องการใช้ curl เรียกจุดสิ้นสุดของแค็ตตาล็อก Learn แบบยังไม่ได้การกรอง และจะแสดงการตอบสนองไปยังไฟล์ที่ชื่อว่า "output.json" ในตําแหน่งที่ตั้งที่กําหนดไว้ในพาธไฟล์ที่แสดงในเทอร์มินัล (เช่น:
C:\Users\<username>
):
curl https://learn.microsoft.com/api/catalog >> output.json
- หากคําขอสําเร็จ คุณควรเห็นข้อมูลเกี่ยวกับขนาดรวมของไฟล์ เช่น 13.1 M (ขนาดอาจเปลี่ยนแปลงได้ ทั้งนี้ขึ้นอยู่กับขนาดของคําตอบ) ถ้าไม่สําเร็จ คุณควรได้รับข้อผิดพลาด
หมายเหตุ
คุณควรลบไฟล์ output.json หลังจากที่คุณใช้งานเสร็จแล้ว หรือเปลี่ยนชื่อเพื่อให้สามารถใช้งานได้มากขึ้น ถ้าคุณคิวรี API อีกครั้งโดยใช้ชื่อไฟล์เดียวกัน ระบบจะผนวกการตอบสนองภายในไฟล์ที่มีอยู่ ตัวเลือกอื่นคือการตั้งชื่อไฟล์อย่างไม่ซ้ํากันมากขึ้นในระหว่างคําสั่งคิวรีเริ่มต้นเช่น "output-1212.json" หรือ "output-de-2022-12-12.json"
ตรวจสอบคําตอบเริ่มต้น
การตอบกลับเริ่มต้นอยู่ใน JSON และจะเป็น "ย่อ" ซึ่งหมายความว่าช่องว่าง บรรทัด และแท็บบางอย่างจะถูกลบออกเพื่อทําให้ไฟล์มีขนาดเล็กลง
- ใน Visual Studio Code เลือก ไฟล์
- เลือก เปิดไฟล์
- นําทางไปยังไฟล์ "output.json" ที่สร้างขึ้นเป็นส่วนหนึ่งของส่วนก่อนหน้า
การลดความเล็กลงนี้เป็นแนวทางปฏิบัติมาตรฐานและไฟล์สามารถ "ถูกแสดงล่วงหน้า" เพื่อให้อ่านได้ง่ายขึ้นโดยคําสั่งใน Visual Studio Code ซึ่งเราจะทําในส่วนถัดไป
ยืนยันการตอบสนอง
- เมื่อเปิดไฟล์ "output.json" ในรหัส Visual Studio ให้ใช้ Ctrl +Shift+I
JSON ควรอัปเดตเพื่อแยกออกเป็นหลายบรรทัดและอยู่ในรูปแบบที่อ่านง่ายขึ้น สําหรับข้อมูลเกี่ยวกับคุณสมบัติและค่าที่แตกต่างกันภายในการตอบสนอง โปรดดู บทความ การอ้างอิงนักพัฒนาแค็ตตาล็อก Learn แค็ตตาล็อก API สําหรับพจนานุกรมข้อมูล
แปลงการตอบสนองเป็นสเปรดชีต
มีหลายคนที่ใช้แค็ตตาล็อก API Learn สําหรับงานแต่ละรายการหรือการตรวจสอบ ซึ่งตรงกันข้ามกับการรวมเข้ากับระบบ สําหรับกรณีการใช้งานเหล่านี้ อาจเป็นประโยชน์ในการแปลงการตอบสนอง JSON เป็นรูปแบบ CSV หรือ Excel เพื่อดูเป็นสเปรดชีต คุณสามารถใช้เครื่องมือแปลงที่ต้องการ แต่ที่นี่เราสามารถใช้ ตัวแปลง Flatfile Json เป็น CSV ได้
- ไปที่: https://csvjson.com/json2csv
- อัปโหลดไฟล์เอาต์พุตของคุณ
- เลือก แปลง
- เลือก ดาวน์โหลด
หมายเหตุ
ระมัดระวังการใช้เครื่องมือออนไลน์ภายนอกเพื่อแปลงข้อมูลและพิจารณาว่าข้อมูลใดที่คุณกําลังใส่ลงไป ในกรณีของ Learn Catalog API การตอบสนองจะพร้อมใช้งานแบบสาธารณะและไม่จําเป็นต้องมีการรับรองความถูกต้อง ดังนั้นจึงสามารถใช้เครื่องมือออนไลน์เพื่อช่วยแปลงรูปแบบได้
ลองใช้คิวรีเพิ่มเติม
ทําตามขั้นตอนข้างต้นเพื่อลองคิวรีเพิ่มเติม เช่นคิวรีที่แสดงด้านล่าง ดูการเปลี่ยนแปลงขนาดของไฟล์คําตอบสําหรับแต่ละไฟล์ และความแตกต่างในวัตถุภายใน
Description | คิวรี |
---|---|
รายการทั้งหมดในแค็ตตาล็อก API การเรียนรู้ | 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 |
ขั้นตอนถัดไป
เราขอแนะนําให้ตรวจทานแหล่งข้อมูลด้านล่างเพื่อช่วยให้คุณในการเดินทางการพัฒนาของคุณ: