Del via

Kom i gang med Katalog-API for Microsoft Learn ved hjelp av curl og Visual Studio Code

  • Artikkel

Denne artikkelen hjelper deg med å komme i gang med katalog-API-en for Microsoft Learn med curl og Visual Studio Code. Hvis du ikke er kjent med detaljene i API-en eller brukstilfellene for den, anbefaler vi at du ser gjennom oversiktsartikkelen for Learn Catalog API-funksjonen først.

Prosessen på høyt nivå vi skal gå gjennom, er:

  1. Spør learn-katalog-API-en
  2. Se gjennom det første svaret
  3. "Prettify" svaret
  4. Konvertere det til et regneark
  5. Prøv flere spørringer

Når du begynner å bruke Learn-katalog-API-en til dine egne behov, kan det hende at du endrer disse trinnene litt, for ønsket verktøysett eller behov, men generelt er prosessen med å bruke det det samme for alle brukstilfeller.

Forutsetninger

Hvis du vil følge trinnene i denne artikkelen, trenger du curl og Visual Studio Code, to populære, gratis verktøy for spørring av API-er.

  • Hvis du allerede har installert curl og Visual Studio Code, kan du gå videre til delen Spørring om API-en for Learn-katalogen.
  • Hvis du ikke har dem installert, følger du instruksjonene i avsnittene nedenfor.

Last ned og konfigurer krøll

curl er et populært, gratis kommandolinjeverktøy med åpen kildekode som kan spørre API-er.

  1. Gå til nedlastingssiden for krøllen, og last ned pakken som gjelder for miljøet ditt. Hvis du ikke er sikker på hvilken du vil velge, bruker du veiviseren for nedlasting av krøller.
  2. Installer programmet, og følg instruksjonene for å konfigurere. Det er ingen unike innstillinger som kreves for denne artikkelen, eller for spørring av learn-katalog-API-en.

Last ned og konfigurer Visual Studio Code

Visual Studio Code er et gratis, kraftig koderedigeringsprogram opprettet av Microsoft.

  1. Gå til Visual Studio Code-nettstedet , og last ned pakken som gjelder for miljøet ditt.
  2. Installer programmet, og følg instruksjonene for å konfigurere.

Spør learn-katalog-API-en

Fordi det ikke kreves godkjenning for å bruke Learn-katalog-API-en, kan du spørre API-endepunktet fra en hvilken som helst kommandolinje som er krøllaktivert. For denne øvelsen bruker vi terminalen i Visual Studio Code.

  1. Åpne Visual Studio Code.
  2. Velg Terminal i den øverste navigasjonen.
  3. Velg Ny terminal for å åpne en ny kommandoterminal.
  4. Velg den valgte terminalen (Bash, CMD osv.), og skriv inn kommandoen nedenfor. Kommandoen nedenfor angir at den ønsker å bruke krøll, kaller opp det ufiltrerte API-endepunktet for Learn-katalogen, og sender svaret til en fil kalt «output.json», på plasseringen som er definert i filbanen som vises i terminalen (for eksempel): C:\Users\<username>
curl https://learn.microsoft.com/api/catalog >> output.json
  1. Hvis forespørselen var vellykket, skal du se informasjon om den totale størrelsen på filen, for eksempel 13,1 M (størrelsen kan endres, avhengig av størrelsen på svaret). Hvis det ikke lyktes, bør du få en feilmelding.

Notat

Du bør slette output.json-filen etter at du er ferdig med å bruke den, eller gi den nytt navn for å være mer aktuell. Hvis du spør etter API-en på nytt ved hjelp av samme filnavn, vil den tilføye svaret i den eksisterende filen. Et annet alternativ er å gi filen et mer unikt navn under den første spørringskommandoen, for eksempel «output-1212.json» eller «output-de-de-2022-12-12.json».

Se gjennom det første svaret

Det første svaret er i JSON og blir «minimert», noe som betyr at bestemte mellomrom, linjer og faner fjernes for å gjøre filen mindre.

  1. Velg Fil i Visual Studio Code.
  2. Velg Åpne fil.
  3. Gå til «output.json»-filen som ble opprettet som en del av den forrige inndelingen.

Denne minimeringen er en standard praksis, og filen kan være "prettified" for å være mer lesbar av en kommando i Visual Studio Code, som vi gjør i neste del.

Prettifisere svaret

  1. Når «output.json»-filen er åpen i Visual Studio Code, bruker du CTRL+SKIFT+I.

JSON bør oppdateres for å deles opp i flere linjer og være i et mer lesbart format. Hvis du vil ha informasjon om de ulike egenskapene og verdiene i svaret, kan du se referanseartikkelen Lær katalog-API-utvikler for dataordlisten.

Konvertere svaret til et regneark

Det er mange personer som bruker Learn Catalog API for individuelle oppgaver eller gjennomgang, i motsetning til å integrere det i et system. I disse brukstilfellene kan det være nyttig å konvertere JSON-svaret til et CSV- eller Excel-format for å vise som et regneark. Du kan bruke et hvilket som helst foretrukket konverteringsverktøy, men her kan vi bruke Flatfile Json til CSV-konverteringsprogram.

  1. Gå til: https://csvjson.com/json2csv.
  2. Last opp utdatafilen.
  3. Velg Konverter.
  4. Velg Last ned.

Notat

Vær svært forsiktig når du bruker eksterne nettbaserte verktøy til å konvertere data, og vurder hvilke data du legger inn i dem. Når det gjelder learn-katalog-API-en, er svaret offentlig tilgjengelig og krever ikke godkjenning, så det er greit å bruke et nettbasert verktøy for å konvertere formatet.

Prøv flere spørringer

Følg fremgangsmåten ovenfor for å prøve flere spørringer, for eksempel de som er oppført nedenfor. Vis hvordan størrelsen på svarfilen endres for hver av dem, og forskjellen i objekter i.

Beskrivelse Query
Alle elementer i Learn Catalog API https://learn.microsoft.com/api/catalog/
Alle spanske moduler https://learn.microsoft.com/api/catalog/?locale=es-es&type=modules
Alle moduler med et popularitetsresultat på 0,9 eller høyere https://learn.microsoft.com/api/catalog/?type=modules&popularity>0.9
Alle sikkerhetsopplærings- og sertifiseringsobjekter for nybegynnere https://learn.microsoft.com/api/catalog/?level=beginner&subject=security
Alle avanserte tilgjengelighetsmoduler med et popularitetsresultat på over 0,5 og oppdatert den siste måneden https://learn.microsoft.com/api/catalog/?level=advanced&subject=accessibility&popularity>0.5&last_modified=gte 2022-10-01

Neste trinn

Vi anbefaler at du går gjennom ressursene nedenfor for å hjelpe deg med utviklingsreisen: