Compartilhar via

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

  • Artigo

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

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

  1. Consultar a API de Catálogo do Learn
  2. Analisar a resposta inicial
  3. "Embelezar" a resposta
  4. Convertê-la em uma planilha
  5. Experimentar mais consultas

Depois de começar a usar a API de Catálogo do Learn para suas necessidades, você poderá modificar um pouco essas etapas, de acordo com o conjunto de ferramentas desejado ou suas necessidades, mas geralmente o processo de uso é o mesmo para todos os casos de uso.

Pré-requisitos

Para seguir as etapas neste artigo, você precisará do cURL e do Visual Studio Code, duas ferramentas populares e gratuitas para consultar APIs.

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

Baixar e configurar o cURL

O cURL é uma ferramenta de linha de comando popular, gratuita e de código aberto que pode consultar APIs.

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

Baixar e configurar o Visual Studio Code

O Visual Studio Code é um editor de código gratuito avançado criado pela Microsoft.

  1. Acesse o site do Visual Studio Code e baixe o pacote aplicável ao seu ambiente.
  2. Instale o aplicativo e siga os prompts para a configuração.

Consultar a API de Catálogo do Learn

Como a autenticação não é necessária para usar a API de Catálogo do Learn, você pode consultar o ponto de extremidade da API de qualquer linha de comando habilitada para 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 preferência (Bash, CMD etc.) e digite o comando abaixo. O comando abaixo indica que ele deseja usar o cURL, chamar o ponto de extremidade não filtrado da API de Catálogo do Learn e gerar a resposta para um arquivo chamado "output.json", no local definido no caminho de 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 tiver sido bem-sucedida, você deverá receber uma mensagem de erro.

Observação

Exclua o arquivo output.json depois 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 ao arquivo existente. Outra opção é nomear o arquivo de maneira mais exclusiva durante o comando de consulta inicial, como "output-1212.json" ou "output-de-de-2022-12-12.json".

Analisar a resposta inicial

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

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

Essa minimização é uma prática padrão e o arquivo pode ser "embelezado" para ficar 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, pressione Ctrl+Shift+I.

O JSON deve ser atualizado para ser dividido em várias linhas e ficar em um formato mais legível. Para obter informações sobre as diferentes propriedades e valores na resposta, confira o artigo de referência para desenvolvedores da API de Catálogo do Learn para ver o dicionário de dados.

Converter a resposta em uma planilha

Muitas pessoas usam a API de Catálogo do Learn para tarefas individuais ou análise, 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 exibi-la como uma planilha. Você pode usar a ferramenta de conversão de sua preferência, mas aqui podemos usar o conversor de JSON em CSV da Flatfile.

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

Observação

Tenha muito cuidado ao usar ferramentas online externas para converter dados e considere quais dados você está disponibilizando para eles. No caso da API de 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.

Experimentar mais consultas

Siga as etapas acima para experimentar mais consultas, como as listadas abaixo. Veja como o tamanho do arquivo de resposta muda para cada consulta, bem como a diferença nos objetos nela.

Descrição Consulta
Todos os itens na API de catálogo do Learn https://learn.microsoft.com/api/catalog/
Todos os módulos espanhóis 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 avançados de acessibilidade 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 analisar os recursos abaixo para ajudar você em seu percurso de desenvolvimento: