Kom igång med Microsoft Learn Catalog API med curl och Visual Studio Code
Den här artikeln hjälper dig att komma igång med microsoft Learn Catalog API med curl och Visual Studio Code. Om du inte känner till informationen om API:et eller användningsfallen för det rekommenderar vi att du läser artikeln Funktionsöversikt för Learn Catalog API först.
Den övergripande process som vi går igenom är:
- Fråga Learn Catalog-API:et
- Granska det första svaret
- Försköna svaret
- Konvertera den till ett kalkylblad
- Prova fler frågor
När du börjar använda Learn Catalog-API:et för dina egna behov kan du komma att ändra de här stegen något för önskad verktygsuppsättning eller dina behov, men vanligtvis är processen med att använda den densamma för alla användningsfall.
Förutsättningar
För att kunna följa stegen i den här artikeln behöver du curl och Visual Studio Code, två populära kostnadsfria verktyg för att fråga API:er.
- Om du redan har installerat curl och Visual Studio Code kan du gå vidare till avsnittet Fråga Learn Catalog API.
- Om du inte har installerat dem följer du anvisningarna i följande avsnitt.
Ladda ned och konfigurera curl
curl är ett populärt, kostnadsfritt kommandoradsverktyg med öppen källkod som kan köra frågor mot API:er.
- Gå till curl Download Page och ladda ned paketet som gäller för din miljö. Om du inte är säker på vilken som ska väljas använder du guiden curl Download.
- Installera programmet och följ anvisningarna för att konfigurera. Det finns inga unika inställningar som behövs för den här artikeln eller för att köra frågor mot LEARN Catalog-API:et.
Ladda ned och konfigurera Visual Studio Code
Visual Studio Code är en kostnadsfri, kraftfull kodredigerare som skapats av Microsoft.
- Gå till Visual Studio Code-webbplatsen och ladda ned paketet som gäller för din miljö.
- Installera programmet och följ anvisningarna för att konfigurera.
Fråga Learn Catalog-API:et
Eftersom det inte krävs någon autentisering för att använda Learn Catalog-API:et kan du fråga API-slutpunkten från alla kommandorader som är curl-aktiverade. I den här övningen använder vi terminalen i Visual Studio Code.
- Öppna Visual Studio Code.
- Välj Terminal i det övre navigeringsfönstret.
- Välj Ny terminal för att öppna en ny kommandoterminal.
- Välj valfri terminal (Bash, CMD osv.) och skriv kommandot nedan. Kommandot nedan anger att den vill använda curl, anropar den ofiltrerade SLUTpunkten för Learn Catalog-API:et och matar ut svaret till en fil med namnet "output.json", på den plats som definierats i filsökvägen som visas i terminalen (t.ex.
C:\Users\<username>):
curl https://learn.microsoft.com/api/catalog >> output.json
- Om begäran lyckades bör du se information om filens totala storlek, till exempel 13,1 M (storleken kan komma att ändras, beroende på svarets storlek). Om det inte lyckades bör du få ett felmeddelande.
Not
Du bör ta bort output.json-filen när du har använt den eller byta namn på den så att den blir mer tillämplig. Om du frågar API:et igen med samma filnamn läggs svaret till i den befintliga filen. Ett annat alternativ är att namnge filen mer unikt under det inledande frågekommandot, till exempel "output-1212.json" eller "output-de-de-2022-12-12.json".
Granska det första svaret
Det första svaret finns i JSON och kommer att "minimeras", vilket innebär att vissa blanksteg, rader och flikar tas bort för att göra filen mindre.
- I Visual Studio Code väljer du Arkiv.
- Välj Öppna fil.
- Gå till filen "output.json" som skapades som en del av föregående avsnitt.
Den här minimeringen är en standardpraxis och filen kan göras "snyggare" för att vara mer läsbar med ett kommando i Visual Studio Code, vilket vi kommer att göra i nästa avsnitt.
Prettifiera svaret
- Använd Ctrl+Skift+I med filen "output.json" öppen i Visual Studio Code.
JSON bör uppdateras för att delas upp i flera rader och vara i ett mer läsbart format. Information om de olika egenskaperna och värdena i svaret finns i referensartikeln Learn Catalog API Developer för dataordlistan.
Konvertera svaret till ett kalkylblad
Det finns många personer som använder Learn Catalog-API:et för enskilda uppgifter eller granskningar, i stället för att integrera det i ett system. I dessa användningsfall kan det vara bra att konvertera JSON-svaret till ett CSV- eller Excel-format för att visa det som ett kalkylblad. Du kan använda valfritt konverteringsverktyg, men här kan vi använda Flatfile Json till CSV-konverteraren.
- Gå till: https://csvjson.com/json2csv.
- Ladda upp utdatafilen.
- Välj Konvertera.
- Välj Ladda ned.
Not
Var mycket försiktig med att använda externa onlineverktyg för att konvertera data och fundera över vilka data du lägger till dem. När det gäller LEARN Catalog-API:et är svaret offentligt tillgängligt och kräver inte autentisering, så det är ok att använda ett onlineverktyg för att konvertera formatet.
Prova fler frågor
Följ stegen ovan för att prova fler frågor, till exempel de som anges nedan. Visa hur svarsfilens storlek ändras för var och en och skillnaden i objekt i.
| Beskrivning | Fråga |
|---|---|
| Alla objekt i Learn Catalog-API:et | https://learn.microsoft.com/api/catalog/ |
| Alla spanska moduler | https://learn.microsoft.com/api/catalog/?locale=es-es&type=modules |
| Alla moduler med en popularitetspoäng på 0,9 eller högre | https://learn.microsoft.com/api/catalog/?type=modules&popularity>0.9 |
| Alla säkerhetsutbildnings- och certifieringsobjekt för nybörjare | https://learn.microsoft.com/api/catalog/?level=beginner&subject=security |
| Alla avancerade hjälpmedelsmoduler med en popularitetspoäng över 0,5 och uppdaterade under den senaste månaden | https://learn.microsoft.com/api/catalog/?level=advanced&subject=accessibility&popularity>0.5&last_modified=gte 2022-10-01 |
Nästa steg
Vi rekommenderar att du granskar resurserna nedan för att hjälpa dig med din utvecklingsresa: