Introduzione all'API catalogo di Microsoft Learn con curl e Visual Studio Code

Articolo
10/07/2023

Questo articolo illustra come iniziare a usare l'API catalogo di Microsoft Learn con curl e Visual Studio Code. Se non si ha familiarità con i dettagli dell'API o dei casi d'uso, è consigliabile esaminare prima di tutto l'articolo della panoramica delle funzionalità api del catalogo di Learn.

Il processo generale che verrà illustrato è:

Eseguire query sull'API del catalogo di Learn
Esaminare la risposta iniziale
"Prettify" la risposta
Convertirlo in un foglio di calcolo
Provare altre query

Quando si inizia a usare l'API Learn Catalog per le proprie esigenze, è possibile modificare questi passaggi leggermente, per il set di strumenti o le esigenze desiderate, ma in genere il processo di utilizzo è lo stesso per tutti i casi d'uso.

Prerequisiti

Per seguire i passaggi descritti in questo articolo, sono necessari curl e Visual Studio Code, due strumenti gratuiti più diffusi per l'esecuzione di query sulle API.

Se curl e Visual Studio Code sono già installati, è possibile passare alla sezione Query sull'API del catalogo di Learn.
Se non sono installati, seguire le istruzioni riportate nelle sezioni seguenti.

Scaricare e configurare curl

curl è uno strumento da riga di comando comune, gratuito, open source che può eseguire query sulle API.

Passare alla pagina di download curl e scaricare il pacchetto applicabile per l'ambiente. Se non si è certi di quale selezionare, usare la procedura guidatadi download curl.
Installare l'applicazione e seguire le istruzioni da configurare. Non sono necessarie impostazioni univoche per questo articolo o per l'esecuzione di query sull'API del catalogo di Learn.

Scaricare e configurare Visual Studio Code

Visual Studio Code è un editor di codice gratuito e potente creato da Microsoft.

Passare al sito di Visual Studio Code e scaricare il pacchetto applicabile per l'ambiente.
Installare l'applicazione e seguire le istruzioni da configurare.

Eseguire query sull'API del catalogo di Learn

Poiché non è necessaria alcuna autenticazione per l'uso dell'API di Learn Catalog, è possibile eseguire query sull'endpoint API da qualsiasi riga di comando abilitata per curl. Per questo esercizio si userà il terminale in Visual Studio Code.

Aprire Visual Studio Code.
Selezionare Terminale nella barra di spostamento superiore.
Selezionare Nuovo terminale per aprire un nuovo terminale dei comandi.
Selezionare il terminale preferito (Bash, CMD e così via) e digitare il comando seguente. Il comando seguente indica che vuole usare curl, chiamare l'endpoint dell'API del catalogo Learn non filtrato e restituirà la risposta a un file denominato "output.json", nel percorso definito nel percorso file illustrato nel terminale (ad esempio: C:\Users\<username>):

curl https://learn.microsoft.com/api/catalog >> output.json

Se la richiesta ha esito positivo, verranno visualizzate informazioni sulle dimensioni totali del file, ad esempio 13,1 M (le dimensioni sono soggette a modifiche, a seconda delle dimensioni della risposta). In caso di esito negativo, dovrebbe essere visualizzato un errore.

Nota

È necessario eliminare il file output.json dopo averlo usato o rinominarlo in modo che sia più applicabile. Se si esegue di nuovo una query sull'API usando lo stesso nome file, la risposta verrà aggiunta all'interno del file esistente. Un'altra opzione consiste nel assegnare un nome più univoco al file durante il comando di query iniziale, ad esempio "output-1212.json" o "output-de-de-2022-12-12.json".

Esaminare la risposta iniziale

La risposta iniziale è in JSON e sarà "ridotta a icona", ovvero alcuni spazi, righe e schede vengono rimossi per ridurre il file.

In Visual Studio Code selezionare File.
Selezionare Apri file.
Passare al file "output.json" creato come parte della sezione precedente.

Questa riduzione al minimo è una procedura standard e il file può essere "prettified" per essere più leggibile da un comando in Visual Studio Code, che verrà eseguito nella sezione successiva.

Abbellisci la riposta

Con il file "output.json" aperto in Visual Studio Code, usare CTRL+MAIUSC+I.

Il codice JSON deve essere aggiornato per suddividere in più righe e avere un formato più leggibile. Per informazioni sulle diverse proprietà e valori all'interno della risposta, vedere l'articolo di riferimento per gli sviluppatori dell'API di Learn Catalog per il dizionario dati.

Convertire la risposta in un foglio di calcolo

Esistono molte persone che usano l'API Learn Catalog per singole attività o verifiche, invece di integrarla in un sistema. Per questi casi d'uso, può essere utile convertire la risposta JSON in un formato CSV o Excel da visualizzare come foglio di calcolo. È possibile usare qualsiasi strumento di conversione preferito, ma qui è possibile usare il convertitoreJson flatfile per CSV.

Passare a: https://csvjson.com/json2csv.
Caricare il file di output.
Seleziona Converti.
Selezionare Download.

Nota

Prestare molta attenzione all'uso di strumenti online esterni per convertire i dati e prendere in considerazione i dati inseriti. Nel caso dell'API del catalogo di Learn, la risposta è disponibile pubblicamente e non richiede l'autenticazione, quindi è possibile usare uno strumento online per convertire il formato.

Provare altre query

Seguire i passaggi precedenti per provare altre query, ad esempio quelle elencate di seguito. Visualizzare il modo in cui le dimensioni del file di risposta cambiano per ogni oggetto e la differenza negli oggetti all'interno.

Descrizione	Query
Tutti gli elementi nell'API Catalogo di Microsoft Learn	`https://learn.microsoft.com/api/catalog/`
Tutti i moduli in spagnolo	`https://learn.microsoft.com/api/catalog/?locale=es-es&type=modules`
Tutti i moduli con un punteggio di popolarità pari a 0,9 o superiore	`https://learn.microsoft.com/api/catalog/?type=modules&popularity>0.9`
Tutti gli oggetti di training e certificazione per principianti	`https://learn.microsoft.com/api/catalog/?level=beginner&subject=security`
Tutti i moduli di accessibilità avanzati con un punteggio di popolarità superiore a 0,5 e aggiornati nell'ultimo mese	`https://learn.microsoft.com/api/catalog/?level=advanced&subject=accessibility&popularity>0.5&last_modified=gte 2022-10-01`

Passaggi successivi

È consigliabile esaminare le risorse seguenti per facilitare il percorso di sviluppo:

Condividi tramite