Compartir a través de

Introducción al uso de la API de catálogo de Microsoft Learn con curl y Visual Studio Code

  • Artículo

Este artículo le ayudará a empezar a usar la API de catálogo de Microsoft Learn con curl y Visual Studio Code. Si no está familiarizado con los detalles de la API o sus casos de uso, se recomienda ver primero el artículo Introducción a la API del catálogo de Microsoft Learn.

El proceso general que vamos a ver es el siguiente:

  1. Consulta de la API de catálogo de Learn
  2. Revisión de la respuesta inicial
  3. Mejora de la respuesta
  4. Conversión de la respuesta en una hoja de cálculo
  5. Prueba de más consultas

Cuando empiece a usar la API de catálogo de Learn para sus propias necesidades, es posible que modifique estos pasos ligeramente para adaptarlos a esas necesidades o al conjunto de herramientas que desee utilizar, pero, en líneas generales, el proceso es el mismo para todos los casos de uso.

Requisitos previos

Para seguir los pasos de este artículo, necesita curl y Visual Studio Code, dos populares herramientas gratuitas para consultar API.

  • Si ya tiene curl y Visual Studio Code instalado, puede ir directamente a la sección Consulta de la API de catálogo de Learn.
  • Si no las tiene instaladas, siga las instrucciones que se proporcionan en las secciones siguientes.

Descarga e instalación de curl

curl es una popular herramienta de línea de comandos de código abierto gratuita que puede consultar API.

  1. Vaya a la página de descarga de curl y descargue el paquete correspondiente a su entorno. Si no está seguro de cuál elegir, use el asistente para la descarga de curl.
  2. Instale la aplicación y siga las indicaciones para configurarla. No hay ninguna configuración única necesaria para este artículo o para consultar la API de catálogo de Learn.

Descarga e instalación de Visual Studio Code

Visual Studio Code es un eficaz editor de código gratuito creado por Microsoft.

  1. Vaya al sitio de Visual Studio Code y descargue el paquete correspondiente a su entorno.
  2. Instale la aplicación y siga las indicaciones para configurarla.

Consulta de la API de catálogo de Learn

Dado que no se requiere autenticación para usar la API de catálogo de Learn, puede consultar el punto de conexión de la API desde cualquier línea de comandos habilitada para curl. En este ejercicio, usaremos el terminal de Visual Studio Code.

  1. Abra Visual Studio Code.
  2. Seleccione Terminal en el panel de navegación superior.
  3. Seleccione Nuevo terminal para abrir un nuevo terminal de comandos.
  4. Elija el terminal que prefiera (Bash, CMD, etc.) y escriba el comando que se incluye a continuación. Este comando indica que quiere usar curl para llamar al punto de conexión de la API de catálogo de Learn sin filtros y generará la respuesta en un archivo denominado "output.json", en la ubicación definida en la ruta de acceso de archivo que se muestra en el terminal (por ejemplo: C:\Users\<username>):
curl https://learn.microsoft.com/api/catalog >> output.json
  1. Si la solicitud se realiza correctamente, debería ver información sobre el tamaño total del archivo, como 13,1 M (el tamaño está sujeto a cambios, dependiendo del tamaño de la respuesta). Si no se realiza correctamente, debería recibir un error.

Nota:

Debe eliminar el archivo output.json una vez que haya terminado de usarlo o cambiarle el nombre para que sea más aplicable. Si vuelve a consultar la API con el mismo nombre de archivo, anexará la respuesta dentro del archivo actual. Otra opción es asignar un nombre al archivo que sea único durante el comando de la consulta inicial, como "output-1212.json" o "output-de-de-2022-12-12.json".

Revisión de la respuesta inicial

La respuesta inicial está en JSON y "minimizada", lo que significa que determinados espacios, líneas y pestañas se quitan para que el archivo sea más pequeño.

  1. En Visual Studio Code, seleccione Archivo.
  2. Seleccione Abrir archivo.
  3. Vaya al archivo “output.json” que se creó en la sección anterior.

Esta minimización es una práctica normal y el archivo se puede mejorar para facilitar su lectura con un comando en Visual Studio Code, lo que haremos en la siguiente sección.

Mejora de la respuesta

  1. Con el archivo “output.json” abierto en Visual Studio Code, use Ctrl+Mayús+I.

El código JSON debe actualizarse para dividirse en varias líneas con un formato más legible. Para obtener información sobre las diferentes propiedades y valores de la respuesta, consulte el artículo Documentación de la API de catálogo de Microsoft Learn para desarrolladores para ver el diccionario de datos.

Conversión de la respuesta en una hoja de cálculo

Hay muchas personas que usan la API de catálogo de Learn para tareas o revisiones individuales, en lugar de integrarla en un sistema. En estos casos, puede resultar útil convertir la respuesta JSON en un formato CSV o de Excel para verla como una hoja de cálculo. Puede usar cualquier herramienta de conversión que prefiera, pero aquí podemos usar el convertidor de JSON a CSV de Flatfile.

  1. Vaya a: https://csvjson.com/json2csv.
  2. Cargue el archivo de salida.
  3. Seleccione Convertir.
  4. Seleccione Descargar.

Nota:

Tenga mucho cuidado con el uso de herramientas en línea externas para convertir datos y tenga en cuenta qué datos pone en ellas. En el caso de la API de catálogo de Learn, la respuesta está disponible públicamente y no requiere autenticación, por lo que se puede usar una herramienta en línea para convertir el formato.

Prueba de más consultas

Siga los pasos anteriores para probar más consultas, como las que se enumeran a continuación. Vea cómo cambia el tamaño del archivo de respuesta para cada uno y la diferencia en los objetos que contiene.

Descripción Consultar
Todos los elementos de la API de catálogo de Learn https://learn.microsoft.com/api/catalog/
Todos los módulos en español https://learn.microsoft.com/api/catalog/?locale=es-es&type=modules
Todos los módulos con una puntuación de popularidad de 0,9 o superior https://learn.microsoft.com/api/catalog/?type=modules&popularity>0.9
Todos los objetos de aprendizaje y certificación sobre seguridad para principiantes https://learn.microsoft.com/api/catalog/?level=beginner&subject=security
Todos los módulos avanzados sobre accesibilidad con una puntuación de popularidad superior a 0,5 y actualizados en el último mes https://learn.microsoft.com/api/catalog/?level=advanced&subject=accessibility&popularity>0.5&last_modified=gte 2022-10-01

Pasos siguientes

Se recomienda consultar los siguientes recursos como ayuda en su recorrido de desarrollo: