Compartir a través de

Introducción a la API del catálogo de Microsoft Learn mediante curl y Visual Studio Code

  • Artículo

Este artículo le ayudará a empezar a usar la API del catálogo de Microsoft Learn con curl y Visual Studio Code. Si no están familiarizados con los detalles de la API o sus casos de uso, les recomendamos que revisen primero el artículo de descripción general de la API de catálogo de Learn .

El proceso de alto nivel que recorreremos es:

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

Una vez que empiece a usar learn Catalog API para sus propias necesidades, puede que modifique estos pasos ligeramente, para sus necesidades o conjunto de herramientas deseados, pero generalmente el proceso de uso es el mismo para todos los casos de uso.

Prerrequisitos

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

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

Descargar y configurar curl

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

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

Descarga y configuración de Visual Studio Code

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

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

Consultar la API del catálogo de Learn

Dado que no hay ninguna autenticación necesaria para usar learn Catalog API, puede consultar el punto de conexión de API desde cualquier línea de comandos habilitada para curl. En este ejercicio, usaremos el terminal en 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 siguiente. El comando siguiente indica que pretende usar curl, llamar al punto de conexión de la API del catálogo de Learn sin filtrar y generará la respuesta en un archivo denominado "output.json", en la ubicación definida en la ruta de archivo que se muestra en la terminal (por ejemplo, C:\Users\<username>):
curl https://learn.microsoft.com/api/catalog >> output.json
  1. Si la solicitud se realizó 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 fuera exitoso, debería recibir un mensaje de error.

Nota

Debe eliminar el archivo output.json después de que haya terminado de usarlo o cambiar su 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 existente. Otra opción es asignar un nombre al archivo de forma más única durante el comando de 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 se "minimizará", lo que significa que se quitan determinados espacios, líneas y pestañas 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ó como parte de la sección anterior.

Esta minimización es una práctica estándar y el archivo se puede "pretificar" para que sea más legible mediante un comando de Visual Studio Code, que se realizará en la sección siguiente.

Embellecer la respuesta

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

El JSON debe actualizarse para dividirse en varias líneas y estar en un formato más legible. Para obtener información sobre las diferentes propiedades y valores dentro de la respuesta, consulte el artículo de referencia para el diccionario de datos de la API de Learn Catalog.

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

Hay muchas personas que usan la API de catálogo de Learn para tareas individuales o revisión, en lugar de integrarla en un sistema. En estos casos de uso, puede resultar útil convertir la respuesta JSON en un formato CSV o Excel para verlo como una hoja de cálculo. Puede usar cualquier herramienta de conversión preferida, pero aquí podemos usar la Json de archivo plano al convertidor csv.

  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 externas en línea para convertir datos y tener en cuenta los datos que está colocando en ellos. 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 es correcto usar una herramienta en línea para ayudar a convertir el formato.

Prueba más consultas

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

Descripción Consulta
Todos los elementos del "Learn Catalog API" https://learn.microsoft.com/api/catalog/
Todos los módulos españoles 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 certificación y aprendizaje de seguridad para principiantes https://learn.microsoft.com/api/catalog/?level=beginner&subject=security
Todos los módulos de accesibilidad avanzados 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 revisar los recursos siguientes para ayudarle en el recorrido de desarrollo: