Prise en main de l’API catalogue Microsoft Learn à l’aide de curl et de Visual Studio Code

Cet article vous aidera à commencer à utiliser l’API catalogue Microsoft Learn avec curl et Visual Studio Code. Si vous n’êtes pas familiarisé avec les détails de l’API ou les cas d’usage pour celui-ci, nous vous recommandons de consulter d’abord l’article de présentation des fonctionnalités de l’API Du catalogue Learn .

Le processus de haut niveau que nous allons parcourir est le suivant :

1. Interroger l’API « Learn Catalog »
2. Passer en revue la réponse initiale
3. « Embellir » la réponse
4. Convertir en feuille de calcul
5. Essayer d’autres requêtes

Une fois que vous avez commencé à utiliser l’API De catalogue Learn pour vos propres besoins, vous pouvez vous retrouver à modifier ces étapes légèrement, pour votre ensemble d’outils ou vos besoins souhaités, mais généralement le processus d’utilisation est le même pour tous les cas d’usage.

Prerequisites

Pour suivre les étapes décrites dans cet article, vous aurez besoin de curl et de Visual Studio Code, deux outils populaires et gratuits pour interroger les API.

• Si vous avez déjà curl et Visual Studio Code installés, vous pouvez passer à la section Interroger l’API du catalogue Learn.
• Si vous ne les avez pas installés, suivez les instructions des sections suivantes.

Télécharger et configurer curl

curl est un outil en ligne de commande populaire, gratuit, open source qui peut interroger des API.

1. Accédez à la page de téléchargement curl et téléchargez le package applicable à votre environnement.
2. Installez l’application et suivez les instructions pour configurer. Il n’existe aucun paramètre unique nécessaire pour cet article ou pour interroger l’API Du catalogue Learn.

Télécharger et configurer Visual Studio Code

Visual Studio Code est un éditeur de code gratuit et puissant créé par Microsoft.

1. Accédez au site Visual Studio Code et téléchargez le package applicable à votre environnement.
2. Installez l’application et suivez les instructions pour configurer.

Interroger l’API « Learn Catalog »

Étant donné qu’aucune authentification n’est requise pour utiliser l’API Du catalogue Learn, vous pouvez interroger le point de terminaison de l’API à partir de n’importe quelle ligne de commande activée pour curl. Pour cet exercice, nous allons utiliser le terminal dans Visual Studio Code.

1. Ouvrez Visual Studio Code.
2. Sélectionnez Terminal dans la navigation supérieure.
3. Sélectionnez Nouveau terminal pour ouvrir un nouveau terminal de commandes.
4. Choisissez votre terminal de votre choix (Bash, CMD, etc.) et tapez la commande ci-dessous. La commande ci-dessous indique qu’elle souhaite utiliser curl, appeler le point de terminaison de l’API du catalogue Learn non filtré et générera la réponse à un fichier appelé «output.json», dans l’emplacement défini dans le chemin de fichier indiqué dans le terminal (par exemple : ) : C:\Users\<username>

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

1. Si la demande a réussi, vous devez voir des informations sur la taille totale du fichier, par exemple 13,1 M (la taille est susceptible de changer, en fonction de la taille de la réponse). S'il n'a pas réussi, vous devriez recevoir un message d'erreur.

Passer en revue la réponse initiale

La réponse initiale est au format JSON et sera « réduite », ce qui signifie que certains espaces, lignes et onglets sont supprimés pour réduire le fichier.

1. Dans Visual Studio Code, sélectionnez Fichier.
2. Sélectionnez Ouvrir le fichier.
3. Accédez au fichier «output.json» créé dans le cadre de la section précédente.

Cette minimisation est une pratique standard et le fichier peut être « prétifié » pour être plus lisible par une commande dans Visual Studio Code, que nous ferons dans la section suivante.

Embellir la réponse

1. Avec le fichier «output.json» ouvert dans Visual Studio Code, utilisez Ctrl+Maj+I.

Le json doit être mis à jour pour fractionner en plusieurs lignes et être dans un format plus lisible. Pour plus d’informations sur les différentes propriétés et valeurs de la réponse, consultez l’article de référence du développeur de l’API Learn Catalog pour le dictionnaire de données.

Convertir la réponse en feuille de calcul

Il existe de nombreuses personnes qui utilisent l’API Du catalogue Learn pour des tâches individuelles ou des révisions, plutôt que de les intégrer dans un système. Pour ces cas d’usage, il peut être utile de convertir la réponse JSON en format CSV ou Excel pour l’afficher sous forme de feuille de calcul. Vous pouvez utiliser n’importe quel outil de conversion préféré, mais ici, nous pouvons utiliser le convertisseur Json flatfile vers CSV.

1. Accédez à : https://csvjson.com/json2csv.
2. Chargez votre fichier de sortie.
3. Sélectionnez Convertir.
4. Sélectionnez Télécharger.

Essayer d’autres requêtes

Suivez les étapes ci-dessus pour essayer d’autres requêtes, telles que celles répertoriées ci-dessous. Affichez la façon dont la taille du fichier de réponse change pour chacune d’elles et la différence entre les objets.

Étapes suivantes

Nous vous recommandons de consulter les ressources ci-dessous pour vous aider dans votre parcours de développement :

• Informations de référence sur les développeurs de l’API catalogue Learn
• Découvrir les meilleures pratiques relatives à l’API catalogue
• FAQ sur l’API du Learn Catalog
• Notes de publication de l’API Learn Catalog