Del via

Kom i gang med Microsoft Learn Catalog-API'en ved hjælp af krøller og Visual Studio Code

  • Artikel

Denne artikel hjælper dig med at komme i gang med at bruge Microsoft Learn Catalog-API'en med krøller og Visual Studio Code. Hvis du ikke kender detaljerne for API'en eller use cases til den, anbefaler vi, at du først gennemser artiklen Oversigt over funktionen Learn Catalog API.

Den proces på højt niveau, vi gennemgår, er:

  1. Forespørg om Learn Catalog-API'en
  2. Gennemse det indledende svar
  3. "Prættificer" svaret
  4. Konvertér det til et regneark
  5. Prøv flere forespørgsler

Når du begynder at bruge Learn Catalog-API'en til dine egne behov, kan du opleve, at du ændrer disse trin en smule for dine ønskede værktøjer eller behov, men generelt er processen med at bruge den den samme for alle use cases.

Forudsætninger

Hvis du vil følge trinnene i denne artikel, skal du bruge krøller og Visual Studio Code, to populære, gratis værktøjer til forespørgsel af API'er.

  • Hvis du allerede har installeret krøller og Visual Studio Code, kan du gå videre til afsnittet Query the Learn Catalog API.
  • Hvis du ikke har dem installeret, skal du følge vejledningen i følgende afsnit.

Download og konfigurer krøller

curl er et populært, gratis, kommandolinjeværktøj med åben kildekode, der kan forespørge API'er.

  1. Gå til krøllen Download side , og download den pakke, der gælder for dit miljø. Hvis du ikke er sikker på, hvilken du skal vælge, skal du bruge guiden Download krøller.
  2. Installér programmet, og følg prompterne for at konfigurere. Der er ingen entydige indstillinger, der er nødvendige for denne artikel, eller for at forespørge om Learn Catalog-API'en.

Download og konfigurer Visual Studio Code

Visual Studio Code er en gratis, effektiv kodeeditor, der er oprettet af Microsoft.

  1. Gå til webstedet Visual Studio Code, og download den pakke, der gælder for dit miljø.
  2. Installér programmet, og følg prompterne for at konfigurere.

Forespørg om Learn Catalog-API'en

Da der ikke kræves godkendelse for at bruge Learn Catalog-API'en, kan du forespørge API-slutpunktet fra en hvilken som helst kommandolinje, der er krølleaktiveret. I denne øvelse bruger vi terminalen i Visual Studio Code.

  1. Åbn Visual Studio Code.
  2. Vælg Terminal i den øverste navigation.
  3. Vælg Ny terminal for at åbne en ny kommandoterminal.
  4. Vælg din valgte terminal (Bash, CMD osv.), og skriv kommandoen nedenfor. Kommandoen nedenfor angiver, at den vil bruge krøller, kalde det ufiltrerede API-slutpunkt for Learn-katalog og sende svaret på en fil med navnet "output.json" på den placering, der er defineret i filstien, der vises i terminalen (f.eks.: C:\Users\<username>):
curl https://learn.microsoft.com/api/catalog >> output.json
  1. Hvis anmodningen lykkedes, kan du se oplysninger om filens samlede størrelse, f.eks. 13,1 M (størrelsen kan ændres, afhængigt af svarets størrelse). Hvis det mislykkedes, får du vist en fejl.

Bemærk

Du bør slette filen output.json, når du er færdig med at bruge den, eller du skal omdøbe den, så den er mere relevant. Hvis du forespørger API'en igen med det samme filnavn, tilføjes svaret i den eksisterende fil. En anden mulighed er at navngive filen mere entydigt under den indledende forespørgselskommando, f.eks. "output-1212.json" eller "output-de-de-2022-12-12.json".

Gennemse det indledende svar

Det første svar er i JSON og vil være "minimeret", hvilket betyder, at visse mellemrum, linjer og faner fjernes for at gøre filen mindre.

  1. Vælg Filer i Visual Studio Code.
  2. Vælg Åbn fil.
  3. Gå til filen "output.json", der blev oprettet som en del af det forrige afsnit.

Denne minimering er en standardpraksis, og filen kan være "prætificeret", så den kan læses mere af en kommando i Visual Studio Code, hvilket vi gør i næste afsnit.

Prættificer svaret

  1. Brug Ctrl+Skift+I, mens filen "output.json" er åben i Visual Studio Code.

JSON skal opdateres, så den opdeles i flere linjer og er i et mere læsevenligt format. Du kan finde oplysninger om de forskellige egenskaber og værdier i svaret i artiklen Udviklerreference til Learn Catalog API for dataordbogen.

Konvertér svaret til et regneark

Der er mange personer, der bruger Learn Catalog-API'en til individuelle opgaver eller gennemsyn i modsætning til at integrere den i et system. I disse use cases kan det være nyttigt at konvertere JSON-svaret til et CSV- eller Excel-format for at få vist som et regneark. Du kan bruge et hvilket som helst foretrukne konverteringsværktøj, men her kan vi bruge Flatfile Json til CSV-konverteringsprogram.

  1. Gå til: https://csvjson.com/json2csv.
  2. Upload outputfilen.
  3. Vælg Konvertér.
  4. Vælg Download.

Bemærk

Vær meget forsigtig med at bruge eksterne onlineværktøjer til at konvertere data, og overvej, hvilke data du lægger i dem. I forbindelse med Learn Catalog-API'en er svaret offentligt tilgængeligt og kræver ikke godkendelse, så det er ok at bruge et onlineværktøj til at hjælpe med at konvertere formatet.

Prøv flere forespørgsler

Følg trinnene ovenfor for at prøve flere forespørgsler, f.eks. dem, der er angivet nedenfor. Få vist, hvordan størrelsen på svarfilen ændres for hver enkelt, og forskellen i objekter i.

Description Anmodning
Alle elementer i Learn Catalog-API'en https://learn.microsoft.com/api/catalog/
Alle spanske moduler https://learn.microsoft.com/api/catalog/?locale=es-es&type=modules
Alle moduler med en popularitetsscore på 0,9 eller højere https://learn.microsoft.com/api/catalog/?type=modules&popularity>0.9
Alle sikkerhedstrænings- og certificeringsobjekter for begyndere https://learn.microsoft.com/api/catalog/?level=beginner&subject=security
Alle avancerede tilgængelighedsmoduler med en popularitetsscore på over 0,5 og opdateret i den sidste måned https://learn.microsoft.com/api/catalog/?level=advanced&subject=accessibility&popularity>0.5&last_modified=gte 2022-10-01

Næste trin

Vi anbefaler, at du gennemgår ressourcerne nedenfor for at hjælpe dig på din udviklingsrejse: