Delen via

Aan de slag met de Microsoft Learn Catalog-API met behulp van curl en Visual Studio Code

  • Artikel

Dit artikel helpt u om aan de slag te gaan met de Microsoft Learn Catalog-API met curl en Visual Studio Code. Als u niet bekend bent met de details van de API of de use cases hiervoor, raden we u aan eerst het overzichtsartikel over de Learn Catalog-API-functie te raadplegen.

Het proces op hoog niveau dat we doorlopen is:

  1. Query's uitvoeren op de Learn Catalog-API
  2. Het eerste antwoord controleren
  3. 'Prettify' het antwoord
  4. Deze converteren naar een spreadsheet
  5. Meer query's uitproberen

Zodra u de Learn Catalog-API voor uw eigen behoeften gaat gebruiken, kunt u deze stappen enigszins aanpassen voor uw gewenste toolset of behoeften, maar over het algemeen is het proces van het gebruik ervan hetzelfde voor alle gebruiksscenario's.

Vereisten

Als u de stappen in dit artikel wilt volgen, hebt u curl en Visual Studio Code nodig, twee populaire, gratis hulpprogramma's voor het uitvoeren van query's op API's.

  • Als u curl en Visual Studio Code al hebt geïnstalleerd, kunt u verdergaan naar de sectie Query the Learn Catalog-API.
  • Als u deze niet hebt geïnstalleerd, volgt u de instructies in de volgende secties.

Curl downloaden en instellen

curl is een populair, gratis, opensource-opdrachtregelprogramma waarmee api's kunnen worden opgevraagd.

  1. Ga naar de curl-downloadpagina en download het pakket dat van toepassing is op uw omgeving. Als u niet zeker weet welke u moet kiezen, gebruikt u de wizard curl downloaden.
  2. Installeer de toepassing en volg de aanwijzingen om te configureren. Er zijn geen unieke instellingen nodig voor dit artikel of voor het uitvoeren van query's op de Learn Catalog-API.

Visual Studio Code downloaden en instellen

Visual Studio Code is een gratis, krachtige code-editor die is gemaakt door Microsoft.

  1. Ga naar de Visual Studio Code-site en download het pakket dat van toepassing is op uw omgeving.
  2. Installeer de toepassing en volg de aanwijzingen om te configureren.

Query's uitvoeren op de Learn Catalog-API

Omdat er geen verificatie is vereist voor het gebruik van de Learn Catalog-API, kunt u een query uitvoeren op het API-eindpunt vanaf elke opdrachtregel waarvoor curl is ingeschakeld. Voor deze oefening gebruiken we de terminal in Visual Studio Code.

  1. Open Visual Studio Code.
  2. Selecteer Terminal in de bovenste navigatiebalk.
  3. Selecteer Nieuwe terminal om een nieuwe opdrachtterminal te openen.
  4. Kies de gewenste terminal (Bash, CMD, enzovoort) en typ de onderstaande opdracht. De onderstaande opdracht geeft aan dat het curl wil gebruiken, het niet-gefilterde Learn Catalog API-eindpunt aanroept en het antwoord uitvoert op een bestand met de naam 'output.json', op de locatie die is gedefinieerd in het bestandspad dat wordt weergegeven in de terminal (bijvoorbeeld: C:\Users\<username>):
curl https://learn.microsoft.com/api/catalog >> output.json
  1. Als de aanvraag is geslaagd, ziet u informatie over de totale grootte van het bestand, zoals 13,1 M (de grootte moet worden gewijzigd, afhankelijk van de grootte van het antwoord). Als het niet lukt, ontvangt u een foutmelding.

Notitie

U moet het bestand output.json verwijderen nadat u klaar bent met het gebruik of de naam ervan wijzigen zodat het beter van toepassing is. Als u de API opnieuw opvraagt met dezelfde bestandsnaam, wordt het antwoord in het bestaande bestand toegevoegd. Een andere optie is om het bestand een uniekere naam te geven tijdens de eerste queryopdracht, zoals 'output-1212.json' of 'output-de-de-2022-12-12.json'.

Het eerste antwoord controleren

Het eerste antwoord bevindt zich in JSON en wordt 'geminimaliseerd', wat betekent dat bepaalde spaties, regels en tabbladen worden verwijderd om het bestand kleiner te maken.

  1. Selecteer Bestand in Visual Studio Code.
  2. Selecteer Bestand openen.
  3. Navigeer naar het bestand output.json dat is gemaakt als onderdeel van de vorige sectie.

Deze minimalisatie is een standaardpraktijk en het bestand kan worden 'voorafgegaan' om beter leesbaar te zijn met een opdracht in Visual Studio Code. Dit doen we in de volgende sectie.

Het antwoord vooraf bepalen

  1. Gebruik Ctrl+Shift+I als het bestand output.json is geopend in Visual Studio Code.

De JSON moet worden bijgewerkt om op te splitsen in meerdere regels en een beter leesbare indeling te hebben. Voor informatie over de verschillende eigenschappen en waarden in het antwoord, bekijkt u het naslagartikel voor ontwikkelaars van de Learn Catalog-API voor de gegevenswoordenlijst.

Het antwoord converteren naar een spreadsheet

Er zijn veel personen die de Learn Catalog-API gebruiken voor afzonderlijke taken of beoordeling, in plaats van deze te integreren in een systeem. Voor deze gebruiksscenario's kan het handig zijn om het JSON-antwoord te converteren naar een CSV- of Excel-indeling om te bekijken als een spreadsheet. U kunt elk gewenst conversieprogramma gebruiken, maar hier kunnen we de Flatfile Json gebruiken voor CSV-conversieprogramma.

  1. Ga naar: https://csvjson.com/json2csv.
  2. Upload het uitvoerbestand.
  3. Selecteer Converteren.
  4. Selecteer Downloaden.

Notitie

Wees zeer voorzichtig met het gebruik van externe online tools om gegevens te converteren en te overwegen welke gegevens u erin plaatst. In het geval van de Learn Catalog-API is het antwoord openbaar beschikbaar en is geen verificatie vereist. Het is dus in orde om een onlinehulpprogramma te gebruiken om de indeling te converteren.

Meer query's uitproberen

Volg de bovenstaande stappen om meer query's uit te voeren, zoals de query's die hieronder worden vermeld. Bekijk hoe de grootte van het antwoordbestand voor elk wordt gewijzigd en het verschil in objecten binnen.

Omschrijving Query’s uitvoeren
Alle items in de Learn Catalog-API https://learn.microsoft.com/api/catalog/
Alle Spaanse modules https://learn.microsoft.com/api/catalog/?locale=es-es&type=modules
Alle modules met een populariteitsscore van 0,9 of hoger https://learn.microsoft.com/api/catalog/?type=modules&popularity>0.9
Alle beveiligingstrainings- en certificeringsobjecten voor beginners https://learn.microsoft.com/api/catalog/?level=beginner&subject=security
Alle geavanceerde toegankelijkheidsmodules met een populariteitsscore van meer dan 0,5 en bijgewerkt in de afgelopen maand https://learn.microsoft.com/api/catalog/?level=advanced&subject=accessibility&popularity>0.5&last_modified=gte 2022-10-01

Volgende stappen

We raden u aan de onderstaande bronnen te bekijken om u te helpen bij uw ontwikkelingstraject: