Mulai menggunakan Microsoft Learn Catalog API menggunakan curl dan Visual Studio Code

Artikel ini akan membantu Anda memulai menggunakan Microsoft Learn Catalog API dengan curl dan Visual Studio Code. Jika Anda tidak terbiasa dengan detail API atau kasus penggunaannya, kami sarankan Anda meninjau artikel gambaran umum fitur Learn Catalog API terlebih dahulu.

Proses tingkat tinggi yang akan kita lalui adalah:

  1. Meminta data dari API Katalog Belajar
  2. Tinjau respons awal
  3. Perindah respons
  4. Mengonversinya menjadi lembar kerja
  5. Coba berbagai kueri

Setelah Anda mulai menggunakan Learn Catalog API untuk kebutuhan Anda sendiri, Anda mungkin menemukan diri Anda memodifikasi langkah-langkah ini sedikit, untuk toolset atau kebutuhan yang Anda inginkan, tetapi umumnya proses penggunaannya sama untuk semua kasus penggunaan.

Prasyarat

Untuk mengikuti langkah-langkah dalam artikel ini, Anda memerlukan curl dan Visual Studio Code, dua alat populer dan gratis untuk mengkueri API.

  • Jika Anda sudah menginstal curl dan Visual Studio Code, Anda dapat melompat ke bagian Kueri Learn Catalog API.
  • Jika Anda belum menginstalnya, ikuti instruksi di bagian berikut.

Unduh dan siapkan curl

curl adalah alat baris perintah populer, gratis, sumber terbuka, yang dapat mengkueri API.

  1. Buka Halaman Unduhan curl dan unduh paket yang berlaku untuk lingkungan Anda.
  2. Instal aplikasi dan ikuti perintah untuk mengonfigurasi. Tidak ada pengaturan unik yang diperlukan untuk artikel ini atau untuk mengkueri Learn Catalog API.

Mengunduh dan menyiapkan Visual Studio Code

Visual Studio Code adalah editor kode gratis dan canggih yang dibuat oleh Microsoft.

  1. Buka situs Visual Studio Code dan unduh paket yang berlaku untuk lingkungan Anda.
  2. Instal aplikasi dan ikuti perintah untuk mengonfigurasi.

Meminta data dari API Katalog Belajar

Karena tidak ada autentikasi yang diperlukan untuk menggunakan Learn Catalog API, Anda dapat mengkueri titik akhir API dari baris perintah apa pun yang diaktifkan curl. Untuk latihan ini, kita akan menggunakan terminal dalam Visual Studio Code.

  1. Buka Visual Studio Code.
  2. Pilih Terminal di navigasi atas.
  3. Pilih Terminal Baru untuk membuka terminal perintah baru.
  4. Pilih terminal pilihan Anda (Bash, CMD, dll.) dan ketik perintah di bawah ini. Perintah di bawah ini menunjukkan bahwa ia ingin menggunakan curl, memanggil titik akhir Learn Catalog API yang tidak difilter, dan akan menghasilkan respons ke file yang disebut "output.json", di lokasi yang ditentukan dalam jalur file yang ditunjukkan di terminal (misalnya: C:\Users\<username>):
curl https://learn.microsoft.com/api/catalog >> output.json
  1. Jika permintaan berhasil, Anda akan melihat informasi tentang ukuran total file, seperti 13,1 M (ukurannya dapat berubah, tergantung pada ukuran respons). Jika tidak berhasil, Anda harusnya menerima pesan kesalahan.

Nota

Anda harus menghapus file output.json setelah selesai menggunakannya, atau mengganti namanya menjadi lebih berlaku. Jika Anda mengkueri API lagi menggunakan nama file yang sama, API akan menambahkan respons dalam file yang ada. Opsi lain adalah memberi nama file secara lebih unik selama perintah kueri awal seperti "output-1212.json" atau "output-de-de-2022-12-12.json".

Tinjau respons awal

Respons awal berada di JSON dan akan "diminimalkan", yang berarti bahwa spasi, baris, dan tab tertentu dihapus untuk membuat file lebih kecil.

  1. Di Visual Studio Code, pilih File.
  2. Pilih Buka File.
  3. Navigasikan ke file "output.json" yang dibuat sebagai bagian dari bagian sebelumnya.

Minimisasi ini adalah praktik standar dan file dapat "diformat ulang" agar lebih mudah dibaca dengan menggunakan perintah di Visual Studio Code, yang akan kita lakukan di bagian berikutnya.

Mempercantik respons

  1. Dengan file "output.json" terbuka di Visual Studio Code, gunakan Ctrl+Shift+I.

JSON harus diperbarui untuk dibagi menjadi beberapa baris dan berada dalam format yang lebih mudah dibaca. Untuk informasi tentang berbagai properti dan nilai dalam respons, lihat artikel referensi Learn Catalog API Developer untuk kamus data.

Mengonversi respons menjadi spreadsheet

Ada banyak orang yang menggunakan Learn Catalog API untuk tugas atau tinjauan individual, dibandingkan dengan mengintegrasikannya ke dalam sistem. Untuk kasus penggunaan ini, mungkin berguna untuk mengonversi respons JSON menjadi format CSV atau Excel untuk ditampilkan sebagai spreadsheet. Anda dapat menggunakan alat konversi pilihan apa pun, tetapi di sini kita dapat menggunakan Flatfile Json ke konverter CSV.

  1. Buka: https://csvjson.com/json2csv.
  2. Unggah file output Anda.
  3. Pilih Konversi.
  4. Pilih Unduh.

Nota

Berhati-hatilah menggunakan alat online eksternal untuk mengonversi data dan mempertimbangkan data apa yang Anda masukkan ke dalamnya. Dalam kasus Learn Catalog API, respons tersedia untuk umum dan tidak memerlukan autentikasi, jadi tidak masalah menggunakan alat online untuk membantu mengonversi format.

Coba berbagai kueri

Ikuti langkah-langkah di atas untuk mencoba lebih banyak kueri, seperti yang tercantum di bawah ini. Lihat bagaimana ukuran file respons berubah untuk masing-masing, dan perbedaan objek di dalamnya.

Deskripsi Kueri
Semua item di Learn Catalog API https://learn.microsoft.com/api/catalog/
Semua modul bahasa Spanyol https://learn.microsoft.com/api/catalog/?locale=es-es&type=modules
Semua modul dengan skor popularitas 0,9 atau lebih tinggi https://learn.microsoft.com/api/catalog/?type=modules&popularity>0.9
Semua objek pelatihan dan sertifikasi keamanan pemula https://learn.microsoft.com/api/catalog/?level=beginner&subject=security
Semua modul aksesibilitas tingkat lanjut dengan skor popularitas lebih dari 0,5 dan diperbarui pada bulan lalu https://learn.microsoft.com/api/catalog/?level=advanced&subject=accessibility&popularity>0.5&last_modified=gte 2022-10-01

Langkah berikutnya

Sebaiknya tinjau sumber daya di bawah ini untuk membantu Anda dalam perjalanan pengembangan Anda:

  • Last updated on