Prise en main de l’API Catalog Microsoft Learn à l’aide de cURL et de Visual Studio Code

Cet article vous aidera à bien démarrer avec l’API Catalog 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 associés, nous vous recommandons de consulter d’abord l’article de présentation des fonctionnalités de l’API Catalog Learn.

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

1. Interroger l’API Catalog Learn
2. Consulter la réponse initiale
3. Optimiser la réponse
4. La convertir en une feuille de calcul
5. Essayer d’autres requêtes

Une fois que vous commencez à utiliser l’API Catalog Learn pour vos propres besoins, vous pouvez modifier légèrement ces étapes, en fonction de l’ensemble d’outils souhaités ou des besoins, mais en général, le processus d’utilisation est le même pour tous les cas d’usage.

Configuration requise

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

• Si curl et Visual Studio Code sont déjà installés, vous pouvez passer directement à la section Interroger l’API Catalog Learn.
• Sinon, suivez les instructions indiquées dans les sections suivantes.

Télécharger et configurer curl

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

1. Accédez à la page de téléchargement de curl et téléchargez le package applicable à votre environnement. Si vous ne savez pas lequel choisir, utilisez l’Assistant Téléchargement de curl.
2. Installez l’application et suivez les invites de configuration. Aucun paramètre unique n’est nécessaire pour cet article ou pour interroger l’API Catalog Learn.

Télécharger et configurer Visual Studio Code

Visual Studio Code est un éditeur de code puissant et gratuit développé 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 invites de configuration.

Interroger l’API Catalog Learn

Étant donné qu’aucune authentification n’est requise pour utiliser l’API Catalog Learn, vous pouvez interroger le point de terminaison de l’API à partir d’une ligne de commande compatible avec curl. Pour cet exercice, vous allez utiliser le terminal dans Visual Studio Code.

1. Ouvrez Visual Studio Code.
2. Sélectionnez Terminal dans le volet de navigation supérieur.
3. Sélectionnez Nouveau terminal pour ouvrir un nouveau terminal de commandes.
4. Choisissez le 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 non filtré de l’API Catalog Learn et générer la réponse dans un fichier appelé « output.json », à l’emplacement défini dans le chemin d’accès affiché dans le terminal (par exemple : C:\Users\<username>) :

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

1. Si la demande réussit, vous devez voir des informations sur la taille totale du fichier, telles que 13,1 M (la taille est susceptible de changer en fonction de la taille de la réponse). En cas d’échec, vous devez recevoir une erreur.

Consulter 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 la taille du fichier.

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

Cette réduction est une pratique standard et le fichier peut être « embelli » pour être plus lisible par une commande dans Visual Studio Code. C’est cette opération que vous allez effectuer dans la section suivante.

Embellir la réponse

1. Le fichier « output.json » étant ouvert dans Visual Studio Code, utilisez Ctrl+Maj+I.

Le JSON doit être mis à jour pour être fractionné 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 Informations de référence sur l’API Catalog Learn destinées aux développeurs pour le dictionnaire de données.

Convertir la réponse en feuille de calcul

De nombreuses personnes utilisent l’API Catalog Learn pour des tâches individuelles ou des révisions, plutôt que de l’intégrer dans un système. Pour ces cas d’usage, il peut être utile de convertir la réponse JSON au format CSV ou Excel pour l’afficher sous forme de feuille de calcul. Vous pouvez utiliser votre outil de conversion préféré, mais ici, vous pouvez utiliser le convertisseur de fichier plat Json en fichier 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. Examinez la façon dont la taille du fichier de réponse change pour chacune d’elles et la différence dans les objets contenus à l’intérieur.

Étapes suivantes

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

• Informations de référence pour les développeurs sur l’API Catalog Learn
• Meilleures pratiques relatives à l’API Catalog Learn
• Questions fréquentes sur l’API Catalog Learn
• Notes de publication de l’API Catalog Learn