Compartilhar via

Introdução à API do Catálogo do Microsoft Learn usando curl e Visual Studio Code

Este artigo ajudará você a começar a usar a API do Catálogo do Microsoft Learn com curl e Visual Studio Code. Se você não estiver familiarizado com os detalhes da API ou os casos de uso dela, recomendamos que revise primeiro o artigo sobre a visão geral do recurso da API do Catálogo de Aprendizado .

O processo de alto nível que vamos percorrer é:

  1. Consultar a API do Learn Catalog
  2. Examinar a resposta inicial
  3. "Pretificar" a resposta
  4. Convertê-lo em uma planilha
  5. Tente mais consultas

Depois de começar a usar a API do Catálogo do Learn para suas próprias necessidades, você poderá se encontrar modificando ligeiramente essas etapas, para o conjunto de ferramentas ou as necessidades desejadas, mas geralmente o processo de usá-la é o mesmo para todos os casos de uso.

Pré-requisitos

Para seguir as etapas deste artigo, você precisará de curl e Visual Studio Code, duas ferramentas populares e gratuitas para consultar APIs.

  • Se você já tiver o Curl e o Visual Studio Code instalados, você poderá ir para a seção Consultar a API do Catálogo do Learn.
  • Se você não os tiver instalado, siga as instruções nas seções a seguir.

Baixar e configurar curl

curl é uma ferramenta popular, gratuita, de software livre e de linha de comando que pode consultar APIs.

  1. Vá para o da Página de Download do curl e baixe o pacote aplicável ao seu ambiente. Se você não tiver certeza de qual escolher, use o assistente curl Download.
  2. Instale o aplicativo e siga as instruções para configurar. Não há configurações exclusivas necessárias para este artigo ou para consultar a API do Catálogo do Learn.

Baixar e configurar o Visual Studio Code

do Visual Studio Code é um editor de código gratuito e poderoso criado pela Microsoft.

  1. Vá para o site do Visual Studio Code e baixe o pacote aplicável ao seu ambiente.
  2. Instale o aplicativo e siga as instruções para configurá-lo.

Fazer uma consulta à API do Catálogo Learn

Uma vez que não é necessária autenticação para usar a API do Catálogo do Learn, você pode consultar o endpoint da API de qualquer linha de comando com suporte a curl. Para este exercício, usaremos o terminal no Visual Studio Code.

  1. Abra o Visual Studio Code.
  2. Selecione Terminal na navegação superior.
  3. Selecione Novo Terminal para abrir um novo terminal de comando.
  4. Escolha seu terminal de escolha (Bash, CMD etc.) e digite o comando abaixo. O comando a seguir indica que deseja usar curl, chamar o endpoint da API do Catálogo 'Learn' não filtrado e gera a resposta em um arquivo chamado "output.json", no local definido no caminho do arquivo mostrado no terminal (por exemplo: C:\Users\<username>):
curl https://learn.microsoft.com/api/catalog >> output.json
  1. Se a solicitação tiver sido bem-sucedida, você deverá ver informações sobre o tamanho total do arquivo, como 13,1 M (o tamanho está sujeito a alterações, dependendo do tamanho da resposta). Se não foi bem-sucedido, você deverá receber um erro.

Nota

Você deve excluir o arquivo output.json depois de terminar de usá-lo ou renomeá-lo para ser mais aplicável. Se você consultar a API novamente usando o mesmo nome de arquivo, ela acrescentará a resposta no arquivo existente. Outra opção é nomear o arquivo de forma mais exclusiva durante o comando de consulta inicial, como "output-1212.json" ou "output-de-de-2022-12-12.json".

Examinar a resposta inicial

A resposta inicial está em JSON e será "minimizada", o que significa que determinados espaços, linhas e guias são removidos para tornar o arquivo menor.

  1. No Visual Studio Code, selecione Arquivo.
  2. Selecione Abrir Arquivo.
  3. Navegue até o arquivo "output.json" que foi criado como parte da seção anterior.

Essa minimização é uma prática padrão e o arquivo pode ser "pretificado" para ser mais legível por um comando no Visual Studio Code, o que faremos na próxima seção.

Embelezar a resposta

  1. Com o arquivo "output.json" aberto no Visual Studio Code, use Ctrl+Shift+I.

O JSON deve ser atualizado para ser dividido em várias linhas e estar em um formato mais legível. Para obter informações sobre as diferentes propriedades e valores dentro da resposta, consulte o artigo de referência do Desenvolvedor da API do Learn Catalog para o dicionário de dados.

Converter a resposta em uma planilha

Há muitas pessoas que usam a API do Catálogo do Learn para tarefas individuais ou revisão, em vez de integrá-la a um sistema. Para esses casos de uso, pode ser útil converter a resposta JSON em um formato CSV ou Excel para exibir como uma planilha. Você pode usar qualquer ferramenta de conversão preferencial, mas aqui podemos usar o conversor Flatfile Json para CSV.

  1. Vá para: https://csvjson.com/json2csv.
  2. Carregue o arquivo de saída.
  3. Selecione Converter.
  4. Selecione Baixar.

Nota

Tenha muito cuidado ao usar ferramentas online externas para converter dados e considere quais dados você está colocando neles. No caso da API do Catálogo do Learn, a resposta está disponível publicamente e não requer autenticação, portanto, não há problema em usar uma ferramenta online para ajudar a converter o formato.

Experimente mais consultas

Siga as etapas acima para experimentar mais consultas, como as listadas abaixo. Exiba como o tamanho do arquivo de resposta muda para cada um e a diferença entre os objetos dentro.

Descrição Consulta
Todos os itens na API do Catálogo Learn https://learn.microsoft.com/api/catalog/
Todos os módulos em espanhol https://learn.microsoft.com/api/catalog/?locale=es-es&type=modules
Todos os módulos com uma pontuação de popularidade igual ou superior a 0,9 https://learn.microsoft.com/api/catalog/?type=modules&popularity>0.9
Todos os objetos de treinamento e certificação de segurança para iniciantes https://learn.microsoft.com/api/catalog/?level=beginner&subject=security
Todos os módulos de acessibilidade avançados com uma pontuação de popularidade acima de 0,5 e atualizados no último mês https://learn.microsoft.com/api/catalog/?level=advanced&subject=accessibility&popularity>0.5&last_modified=gte 2022-10-01

Próximas etapas

Recomendamos revisar os recursos abaixo para ajudá-lo em sua jornada de desenvolvimento:

  • Referência do desenvolvedor da API Learn Catalog
  • Práticas recomendadas da API de Catálogo do Learn
  • perguntas frequentes sobre a API do Catálogo do Learn
  • Notas de versão da API de Catálogo Learn