Поделиться через

Начало работы с API каталога Microsoft Learn с помощью curl и Visual Studio Code

Эта статья поможет вам приступить к работе с API каталога Microsoft Learn с curl и Visual Studio Code. Если вы не знакомы с подробными сведениями об API или вариантах использования, рекомендуем сначала ознакомиться с обзором функций API каталога Learn.

Высокоуровневый процесс, который мы рассмотрим:

  1. Запрос API каталога Learn
  2. Просмотр первоначального ответа
  3. Ответ "Prettify"
  4. Преобразование его в электронную таблицу
  5. Попробуйте использовать дополнительные запросы

После того как вы начнете использовать API каталога Learn для собственных потребностей, вы можете немного изменить эти шаги для требуемого набора инструментов или потребностей, но обычно процесс использования это одинаково для всех вариантов использования.

Необходимые компоненты

Чтобы выполнить действия, описанные в этой статье, вам потребуется curl и Visual Studio Code, два популярных бесплатных средства для запроса API.

  • Если вы уже установили curl и Visual Studio Code, перейдите к разделу API каталога Learn.
  • Если они не установлены, следуйте инструкциям в следующих разделах.

Скачивание и настройка curl

curl — это популярное средство командной строки с открытым исходным кодом, которое может запрашивать API.

  1. Перейдите на страницу скачивания curl и скачайте пакет, применимый для вашей среды. Если вы не уверены, какой из них выбрать, используйте мастер скачивания curl.
  2. Установите приложение и следуйте инструкциям по настройке. Для этой статьи нет уникальных параметров или запросов к API каталога Learn.

Скачивание и настройка Visual Studio Code

Visual Studio Code — это бесплатный, мощный редактор кода, созданный корпорацией Майкрософт.

  1. Перейдите на сайт Visual Studio Code и скачайте пакет, применимый для вашей среды.
  2. Установите приложение и следуйте инструкциям по настройке.

Запрос API каталога Learn

Так как для использования API каталога Learn не требуется проверка подлинности, вы можете запросить конечную точку API из любой командной строки с поддержкой curl. В этом упражнении мы будем использовать терминал в Visual Studio Code.

  1. Откройте Visual Studio Code.
  2. Выберите терминал в верхней области навигации.
  3. Выберите новый терминал, чтобы открыть новый командный терминал.
  4. Выберите выбранный терминал (Bash, CMD и т. д.) и введите следующую команду. Следующая команда указывает, что она хочет использовать curl, вызовите конечную точку API нефильтрованного каталога Learn и выдаст ответ на файл с именем output.json, в расположении, указанном в файле пути, показанном в терминале (например: ): C:\Users\<username>
curl https://learn.microsoft.com/api/catalog >> output.json
  1. Если запрос выполнен успешно, вы увидите сведения о общем размере файла, например 13,1 M (размер зависит от размера ответа). Если ошибка не выполнена, вы должны получить сообщение об ошибке.

Примечание.

После завершения работы удалите файл output.json или переименуйте его, чтобы оно было более применимым. При повторном запросе API с тем же именем файла он добавит ответ в существующий файл. Другой вариант — присвоить файлу более уникальное имя во время начальной команды запроса, например output-1212.json или output-de-de-2022-12-12.json.

Просмотр первоначального ответа

Начальный ответ находится в формате JSON и будет "свернут", что означает, что некоторые пробелы, строки и вкладки удаляются для уменьшения размера файла.

  1. В Visual Studio Code выберите "Файл".
  2. Выберите "Открыть файл".
  3. Перейдите к файлу output.json, созданному в рамках предыдущего раздела.

Эта минимизация является стандартной практикой, и файл может быть "предустановлен" для чтения командой в Visual Studio Code, которую мы сделаем в следующем разделе.

Подготовка ответа

  1. Открыв файл output.json в Visual Studio Code, используйте ctrl+SHIFT+I.

Json должен обновляться, чтобы разделиться на несколько строк и иметь более читаемый формат. Дополнительные сведения о различных свойствах и значениях в ответе см . в справочной статье разработчика API каталога Learn для словаря данных.

Преобразование ответа в электронную таблицу

Существует много людей, использующих API каталога Learn для отдельных задач или проверки, в отличие от интеграции его в систему. В таких случаях полезно преобразовать ответ JSON в формат CSV или Excel для просмотра в виде электронной таблицы. Вы можете использовать любой предпочтительный инструмент преобразования, но здесь мы можем использовать преобразователь Flatfile Json для CSV.

  1. Перейдите к: https://csvjson.com/json2csv
  2. Отправьте выходной файл.
  3. Выберите Преобразовать.
  4. Щелкните Скачать.

Примечание.

Будьте очень осторожны с помощью внешних онлайн-инструментов для преобразования данных и рассмотрите, какие данные вы помещаете в них. В случае API каталога Learn ответ является общедоступным и не требует проверки подлинности, поэтому он подходит для использования онлайн-инструмента для преобразования формата.

Попробуйте использовать дополнительные запросы

Выполните описанные выше действия, чтобы попробовать дополнительные запросы, например перечисленные ниже. Просмотрите, как изменяется размер файла ответа для каждого из них и разница в объектах внутри.

Description Query
Все элементы в API каталога Learn https://learn.microsoft.com/api/catalog/
Все испанские модули https://learn.microsoft.com/api/catalog/?locale=es-es&type=modules
Все модули с оценкой популярности 0,9 или выше https://learn.microsoft.com/api/catalog/?type=modules&popularity>0.9
Все начальные объекты обучения и сертификации https://learn.microsoft.com/api/catalog/?level=beginner&subject=security
Все расширенные модули специальных возможностей с оценкой популярности более 0,5 и обновлены в прошлом месяце https://learn.microsoft.com/api/catalog/?level=advanced&subject=accessibility&popularity>0.5&last_modified=gte 2022-10-01

Следующие шаги

Мы рекомендуем ознакомиться с приведенными ниже ресурсами, чтобы помочь вам в процессе разработки: