Introdução à API do Catálogo do Microsoft Learn usando curl e Visual Studio Code
Este artigo irá ajudá-lo 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 você revise o artigo de visão geral do recurso Learn Catalog API primeiro.
O processo de alto nível que vamos percorrer é:
- Consultar a API do Catálogo do Learn
- Reveja a resposta inicial
- "Prettify" a resposta
- Convertê-lo em uma planilha
- Experimente mais consultas
Depois de começar a usar a API do Learn Catalog para suas próprias necessidades, você pode se encontrar modificando essas etapas ligeiramente, para o conjunto de ferramentas ou necessidades desejadas, mas geralmente o processo de usá-la é 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á pular para a seção Consultar a API do Catálogo de Aprendizagem.
- Se não os tiver instalados, siga as instruções nas secções seguintes.
Download e configuração de curl
curl é uma ferramenta de linha de comando popular, gratuita e de código aberto que pode consultar APIs.
- Vá para a página de download curl e baixe o pacote aplicável ao seu ambiente. Se não tiver certeza de qual escolher, use o assistente de download do curl.
- 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
Visual Studio Code é um editor de código gratuito e poderoso criado pela Microsoft.
- Vá para o site Visual Studio Code e baixe o pacote aplicável ao seu ambiente.
- Instale o aplicativo e siga as instruções para configurar.
Consultar a API do Learn Catalog
Como não é necessária autenticação para usar a API do Catálogo do Learn, pode consultar o ponto de extremidade da API a partir de qualquer linha de comando com suporte a curl. Para este exercício, usaremos o terminal dentro do Visual Studio Code.
- Abra o Visual Studio Code.
- Selecione Terminal na navegação superior.
- Selecione Novo Terminal para abrir um novo terminal de comando.
- Escolha o seu terminal de escolha (Bash, CMD, etc.) e digite o comando abaixo. O comando abaixo indica o uso de curl, chama o endpoint não filtrado da API do Learn Catalog e envia a resposta para um ficheiro chamado "output.json", na localização indicada pelo caminho de ficheiro no terminal (por exemplo:
C:\Users\<username>).
curl https://learn.microsoft.com/api/catalog >> output.json
- Se a solicitação foi bem-sucedida, você 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 êxito, deverá receber um erro.
Observação
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 dentro do 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".
Reveja a resposta inicial
A resposta inicial está em JSON e será "minimizada", o que significa que certos espaços, linhas e guias são removidos para tornar o arquivo menor.
- No Visual Studio Code, selecione Arquivo.
- Selecione Abrir arquivo.
- 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 "prettified" para ser mais legível por um comando no Visual Studio Code, o que faremos na próxima seção.
Embelezar a resposta
- Com o arquivo "output.json" aberto no Visual Studio Code, use Ctrl+Shift+I.
O JSON deve ser atualizado para se dividir em várias linhas e estar em um formato mais legível. Para obter informações sobre as diferentes propriedades e valores na resposta, consulte o artigo de referência do Learn Catalog API Developer para o dicionário de dados.
Converter a resposta numa folha de cálculo
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 preferida, mas aqui podemos usar o conversor Flatfile Json para CSV.
- Vá para: https://csvjson.com/json2csv.
- Carregue o seu ficheiro de saída.
- Selecione Converter.
- Selecione Download.
Observação
Tenha muito cuidado ao usar ferramentas on-line 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, por isso não há problema em usar uma ferramenta online para ajudar a converter o formato.
Experimente mais consultas
Siga as etapas acima para tentar mais consultas, como as listadas abaixo. Veja como o tamanho do arquivo de resposta muda para cada um e a diferença nos objetos dentro.
| Descrição | Consulta |
|---|---|
| Todos os itens na API do Catálogo de Aprendizagem | https://learn.microsoft.com/api/catalog/ |
| Todos os módulos de espanhol | https://learn.microsoft.com/api/catalog/?locale=es-es&type=modules |
| Todos os módulos com uma pontuação de popularidade de 0,9 ou superior | 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çada com uma pontuação de popularidade acima de 0,5 e atualizado no último mês | https://learn.microsoft.com/api/catalog/?level=advanced&subject=accessibility&popularity>0.5&last_modified=gte 2022-10-01 |
Próximos passos
Recomendamos rever os recursos abaixo para ajudá-lo em sua jornada de desenvolvimento: