Udostępnij za pośrednictwem

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

  • Artykuł

Ten artykuł pomoże Ci rozpocząć korzystanie z interfejsu API wykazu usługi Microsoft Learn z narzędziem curl i programem Visual Studio Code. Jeśli nie znasz szczegółów interfejsu API lub przypadków użycia, zalecamy zapoznanie się z artykułem Omówienie funkcji wykazu usługi Learn.

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

  1. Wykonywanie zapytań względem interfejsu API wykazu platformy Learn
  2. Przejrzyj początkową odpowiedź
  3. "Prettify" odpowiedź
  4. Konwertowanie go na arkusz kalkulacyjny
  5. Wypróbuj więcej zapytań

Po rozpoczęciu korzystania z interfejsu API wykazu platformy Learn dla własnych potrzeb możesz nieco zmodyfikować te kroki, w żądanym zestawie narzędzi lub potrzebach, ale ogólnie proces jego używania jest taki sam w przypadku wszystkich przypadków 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. Jeśli nie masz pewności, który z nich wybrać, użyj kreatora pobierania curl.
  2. Zainstaluj aplikację i postępuj zgodnie z monitami, aby skonfigurować. W tym artykule nie są wymagane żadne unikatowe ustawienia ani wykonywanie zapytań dotyczących interfejsu API wykazu platformy Learn.

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ń względem interfejsu API wykazu platformy Learn

Ponieważ do korzystania z interfejsu API wykazu platformy Learn nie jest wymagane uwierzytelnianie, możesz wykonać zapytanie dotyczące punktu końcowego interfejsu API z poziomu dowolnego wiersza polecenia z włączoną obsługą narzędzia curl. W tym ćwiczeniu użyjemy terminalu w programie Visual Studio Code.

  1. Otwórz 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 wykazu 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.

Uwaga

Plik output.json należy usunąć po zakończeniu korzystania z niego lub zmienić jego nazwę, aby był bardziej odpowiedni. Jeśli ponownie wykonasz zapytanie dotyczące interfejsu API przy użyciu tej samej nazwy pliku, dołączy odpowiedź w istniejącym pliku. Inną opcją jest nadanie plikowi unikatowego nazwy podczas początkowego polecenia zapytania, takiego jak "output-1212.json" lub "output-de-de-2022-12-12.json".

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że być "poprzedzony" bardziej czytelnym poleceniem w programie Visual Studio Code, które wykonamy w następnej sekcji.

Prettify the response (Wstępne określanie odpowiedzi)

  1. Po otwarciu pliku "output.json" w programie Visual Studio Code użyj klawiszy 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ł Dokumentacja dla deweloperów interfejsu API wykazu usługi Learn dla słownika danych.

Konwertowanie odpowiedzi na arkusz kalkulacyjny

Istnieje wiele osób, które używają interfejsu API wykazu platformy Learn do poszczególnych zadań lub przeglądu, w przeciwieństwie do integracji 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.

Uwaga

Należy bardzo ostrożnie używać zewnętrznych narzędzi online do konwertowania danych i wziąć pod uwagę dane wprowadzane do nich. W przypadku interfejsu API wykazu platformy Learn odpowiedź jest publicznie dostępna i nie wymaga uwierzytelniania, więc możesz użyć narzędzia online, aby ułatwić konwersję formatu.

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 dla każdej z nich oraz różnice w obiektach w programie.

opis Zapytanie
Wszystkie elementy w interfejsie API wykazu platformy Learn https://learn.microsoft.com/api/catalog/
Wszystkie moduły hiszpańskie https://learn.microsoft.com/api/catalog/?locale=es-es&type=modules
Wszystkie moduły z oceną popularności na poziomie 0,9 lub wyższym https://learn.microsoft.com/api/catalog/?type=modules&popularity>0.9
Wszystkie obiekty szkoleń i certyfikacji zabezpieczeń dla początkujących https://learn.microsoft.com/api/catalog/?level=beginner&subject=security
Wszystkie zaawansowane moduły ułatwień dostępu z wynikiem popularności powyżej 0,5 i zaktualizowane w ostatnim miesiącu https://learn.microsoft.com/api/catalog/?level=advanced&subject=accessibility&popularity>0.5&last_modified=gte 2022-10-01

Następne kroki

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