Rozpoczynanie pracy z interfejsem API wykazu usługi Microsoft Learn przy użyciu narzędzia curl i programu Visual Studio Code

Ten artykuł pomoże Ci rozpocząć korzystanie z interfejsu API katalogu Microsoft Learn za pomocą curl i programu Visual Studio Code. Jeśli nie znasz szczegółów API lub jego przypadków użycia, zalecamy zapoznanie się z artykułem przeglądowym funkcji API katalogu Learn.

Ogólny proces, który omówimy, to:

1. Wykonywanie zapytań do interfejsu API katalogu Learn
2. Przejrzyj początkową odpowiedź
3. Upiększ odpowiedź
4. Konwertowanie go na arkusz kalkulacyjny
5. Wypróbuj więcej zapytań

Po rozpoczęciu korzystania z interfejsu API katalogu Learn dla własnych potrzeb, możesz nieco zmodyfikować te kroki zgodnie z wymaganym zestawem narzędzi lub potrzebami, ale ogólnie proces jego używania jest taki sam w innych przypadkach użycia.

Wymagania wstępne

Aby wykonać kroki opisane w tym artykule, potrzebne będą narzędzia curl i Visual Studio Code, dwa popularne, bezpłatne narzędzia do wykonywania zapytań o interfejsy API.

• Jeśli masz już zainstalowany program curl i program Visual Studio Code, możesz przejść do sekcji Query the Learn Catalog API (Wykonywanie zapytań za pomocą interfejsu API wykazu platformy Learn).
• Jeśli nie masz ich zainstalowanych, postępuj zgodnie z instrukcjami w poniższych sekcjach.

Pobieranie i konfigurowanie narzędzia curl

Curl to popularne, bezpłatne, open source, narzędzie wiersza polecenia, które może wykonywać zapytania o interfejsy API.

1. Przejdź do strony pobierania curl i pobierz pakiet odpowiedni dla danego środowiska.
2. Zainstaluj aplikację i postępuj zgodnie z monitami, aby skonfigurować. W tym artykule nie są wymagane żadne specjalne ustawienia ani zapytania do Learn Catalog API.

Pobieranie i konfigurowanie programu Visual Studio Code

Visual Studio Code to bezpłatny, zaawansowany edytor kodu utworzony przez firmę Microsoft.

1. Przejdź do witryny programu Visual Studio Code i pobierz pakiet odpowiedni dla danego środowiska.
2. Zainstaluj aplikację i postępuj zgodnie z monitami, aby skonfigurować.

Wykonywanie zapytań do interfejsu API katalogu Learn

Ponieważ do korzystania z Learn Catalog API nie jest wymagane uwierzytelnianie, możesz wykonać zapytanie do endpointu API z dowolnego wiersza poleceń obsługującego curl. W tym ćwiczeniu użyjemy terminalu w programie Visual Studio Code.

1. Otwórz program Visual Studio Code.
2. Wybierz pozycję Terminal w górnej nawigacji.
3. Wybierz pozycję Nowy terminal, aby otworzyć nowy terminal poleceń.
4. Wybierz wybrany terminal (Bash, CMD itp.) i wpisz poniższe polecenie. Poniższe polecenie wskazuje, że chce użyć narzędzia curl, wywołać niefiltrowany punkt końcowy interfejsu API katalogu usługi Learn i wyświetli odpowiedź na plik o nazwie "output.json", w lokalizacji zdefiniowanej w ścieżce plików pokazanej w terminalu (np. C:\Users\<username>):

curl https://learn.microsoft.com/api/catalog >> output.json

1. Jeśli żądanie zakończyło się pomyślnie, powinny zostać wyświetlone informacje o całkowitym rozmiarze pliku, takim jak 13,1 M (rozmiar może ulec zmianie, w zależności od rozmiaru odpowiedzi). Jeśli to się nie powiedzie, powinien zostać wyświetlony błąd.

Przejrzyj początkową odpowiedź

Początkowa odpowiedź jest w formacie JSON i będzie "zminimalizowana", co oznacza, że niektóre spacje, wiersze i karty zostaną usunięte, aby plik był mniejszy.

1. W programie Visual Studio Code wybierz pozycję Plik.
2. Wybierz pozycję Otwórz plik.
3. Przejdź do pliku "output.json", który został utworzony w ramach poprzedniej sekcji.

Ta minimalizacja jest standardową praktyką, a plik można „uporządkować,” aby był bardziej czytelny, używając polecenia w Visual Studio Code, co zrobimy w następnej sekcji.

Upiększ odpowiedź

1. Po otwarciu pliku "output.json" w programie Visual Studio Code użyj Ctrl+Shift+I.

Kod JSON powinien zostać zaktualizowany, aby podzielić na wiele wierszy i mieć bardziej czytelny format. Aby uzyskać informacje o różnych właściwościach i wartościach w odpowiedzi, zobacz artykuł Learn Catalog API Developer reference dotyczący słownika danych.

Konwertowanie odpowiedzi na arkusz kalkulacyjny

Istnieje wiele osób, które używają API katalogu Learn do zadań indywidualnych lub przeglądu zamiast integrowania go z systemem. W takich przypadkach użycia pomocne może być przekonwertowanie odpowiedzi JSON na format CSV lub Excel w celu wyświetlenia go jako arkusza kalkulacyjnego. Możesz użyć dowolnego preferowanego narzędzia konwersji, ale w tym miejscu możemy użyć konwertera Flatfile Json do CSV.

1. Przejdź do: https://csvjson.com/json2csv.
2. Przekaż plik wyjściowy.
3. Wybierz pozycję Konwertuj.
4. Wybierz Pobierz.

Wypróbuj więcej zapytań

Wykonaj powyższe kroki, aby wypróbować więcej zapytań, takich jak wymienione poniżej. Zobacz, jak zmienia się rozmiar pliku odpowiedzi oraz różnice w obiektach w jego obrębie.

Dalsze kroki

Zalecamy zapoznanie się z poniższymi zasobami, aby ułatwić Ci proces opracowywania:

• Dokumentacja interfejsu API katalogu Learn dla deweloperów
• Poznaj najlepsze praktyki dotyczące interfejsu API katalogu
• Często zadawane pytania dotyczące interfejsu API katalogu
• Dowiedz się więcej o informacjach o wydaniu interfejsu API katalogu