Začínáme s rozhraním API katalogu Microsoft Learn pomocí nástroje curl a editoru Visual Studio Code

  • Článek

Tento článek vám pomůže začít používat rozhraní API katalogu Microsoft Learn s curl a editorem Visual Studio Code. Pokud neznáte podrobnosti rozhraní API nebo případy použití, doporučujeme nejprve projít si článek s přehledem funkcí rozhraní API pro katalog Learn.

Proces vysoké úrovně, který si projdeme, je:

  1. Dotazování rozhraní API katalogu Learn
  2. Kontrola počáteční odpovědi
  3. "Prettify" odpověď
  4. Převést na tabulku
  5. Vyzkoušení dalších dotazů

Jakmile začnete používat rozhraní API katalogu Learn pro vlastní potřeby, můžete tyto kroky mírně upravit pro požadovanou sadu nástrojů nebo potřeby, ale obecně je proces použití stejný pro všechny případy použití.

Požadavky

Abyste mohli postupovat podle kroků v tomto článku, budete potřebovat curl a Visual Studio Code, dva oblíbené bezplatné nástroje pro dotazování rozhraní API.

  • Pokud už máte curl a Visual Studio Code nainstalované, můžete přejít k části Dotazování rozhraní API katalogu Learn.
  • Pokud je nemáte nainstalované, postupujte podle pokynů v následujících částech.

Stažení a nastavení curl

Curl je oblíbený bezplatný opensourcový nástroj příkazového řádku, který dokáže dotazovat rozhraní API.

  1. Přejděte na stránku ke stažení curl a stáhněte balíček použitelný pro vaše prostředí. Pokud si nejste jistí, který z nich vybrat, použijte průvodce stažením curl.
  2. Nainstalujte aplikaci a postupujte podle pokynů ke konfiguraci. Pro tento článek ani pro dotazování rozhraní API katalogu Learn není potřeba žádná jedinečná nastavení.

Stažení a nastavení editoru Visual Studio Code

Visual Studio Code je bezplatný výkonný editor kódu vytvořený Microsoftem.

  1. Přejděte na web editoru Visual Studio Code a stáhněte balíček použitelný pro vaše prostředí.
  2. Nainstalujte aplikaci a postupujte podle pokynů ke konfiguraci.

Dotazování rozhraní API katalogu Learn

Vzhledem k tomu, že pro použití rozhraní API katalogu Learn není potřeba žádné ověřování, můžete se na koncový bod rozhraní API dotazovat z libovolného příkazového řádku, který je povolený curl. V tomto cvičení použijeme terminál v editoru Visual Studio Code.

  1. Otevřete Visual Studio Code.
  2. V horním navigačním panelu vyberte Terminál.
  3. Výběrem možnosti Nový terminál otevřete nový příkazový terminál.
  4. Vyberte terminál podle výběru (Bash, CMD atd.) a zadejte níže uvedený příkaz. Následující příkaz označuje, že chce použít curl, volat nefiltrovaný koncový bod rozhraní API katalogu Learn a vypíše odpověď do souboru s názvem output.json v umístění definovaném v cestě k souboru zobrazeném v terminálu (např. C:\Users\<username>):
curl https://learn.microsoft.com/api/catalog >> output.json
  1. Pokud žádost proběhla úspěšně, měli byste vidět informace o celkové velikosti souboru, například 13,1 M (velikost se může změnit v závislosti na velikosti odpovědi). Pokud došlo k neúspěchu, měla by se zobrazit chyba.

Poznámka

Po jeho použití byste měli odstranit soubor output.json nebo ho přejmenovat tak, aby byl použitelný. Pokud dotazujete rozhraní API znovu pomocí stejného názvu souboru, připojí odpověď do existujícího souboru. Další možností je pojmenovat soubor jedinečněji během počátečního příkazu dotazu, například output-1212.json nebo output-de-de-2022-12-12.json.

Kontrola počáteční odpovědi

Počáteční odpověď je ve formátu JSON a bude "minimalizovaná", což znamená, že se odeberou určité mezery, řádky a tabulátory, aby se soubor zmenšil.

  1. V editoru Visual Studio Code vyberte Soubor.
  2. Vyberte Otevřít soubor.
  3. Přejděte do souboru output.json, který byl vytvořen jako součást předchozí části.

Tato minimalizace je standardním postupem a soubor může být "předem" čitelnější příkazem v editoru Visual Studio Code, který provedeme v další části.

Prettify the response

  1. S otevřeným souborem output.json v editoru Visual Studio Code použijte kombinaci kláves Ctrl+Shift+I.

Json by se měl aktualizovat tak, aby se rozdělil na více řádků a byl v čitelnějším formátu. Informace o různých vlastnostech a hodnotách v odpovědi najdete v referenčním článku o vývojáři rozhraní API služby Learn Catalog pro datový slovník.

Převedení odpovědi na tabulku

Existuje mnoho lidí, kteří používají rozhraní API katalogu Learn pro jednotlivé úlohy nebo kontrolu, na rozdíl od integrace do systému. V těchto případech použití může být užitečné převést odpověď JSON do formátu CSV nebo Excelu, aby se zobrazila jako tabulka. Můžete použít jakýkoli preferovaný nástroj pro převod, ale tady můžeme použít flatfile Json do csv převaděče.

  1. Přejděte na: https://csvjson.com/json2csv.
  2. Nahrajte výstupní soubor.
  3. Vyberte Převést.
  4. Vyberte položku Stáhnout.

Poznámka

Buďte velmi opatrní pomocí externích online nástrojů k převodu dat a zvažte, jaká data do nich vkládáte. V případě rozhraní API katalogu Learn je odpověď veřejně dostupná a nevyžaduje ověřování, takže je v pořádku použít online nástroj k převodu formátu.

Vyzkoušení dalších dotazů

Pokud chcete vyzkoušet další dotazy, například ty, které jsou uvedené níže, postupujte podle výše uvedených kroků. Podívejte se, jak se mění velikost souboru odpovědi pro jednotlivé objekty a jaký je rozdíl v objektech uvnitř.

Popis Dotaz
Všechny položky v rozhraní API katalogu Learn https://learn.microsoft.com/api/catalog/
Všechny španělské moduly https://learn.microsoft.com/api/catalog/?locale=es-es&type=modules
Všechny moduly s hodnocením popularity 0,9 nebo vyšší https://learn.microsoft.com/api/catalog/?type=modules&popularity>0.9
Všechny objekty pro školení a certifikaci zabezpečení pro začátečníky https://learn.microsoft.com/api/catalog/?level=beginner&subject=security
Všechny pokročilé moduly přístupnosti s skóre popularity nad 0,5 a aktualizovány za poslední měsíc https://learn.microsoft.com/api/catalog/?level=advanced&subject=accessibility&popularity>0.5&last_modified=gte 2022-10-01

Další kroky

Doporučujeme projít si následující zdroje informací, které vám pomůžou na cestě vývoje: