Zdieľať cez

Začíname s rozhraním API pre Microsoft Learn Catalog pomocou kučier a Visual Studia Code

  • Článok

Tento článok vám pomôže začať používať rozhranie API pre Microsoft Learn Catalog so zloženým a Visual Studio Code. Ak nie ste oboznámení s podrobnosťami o rozhraní API alebo o prípadoch jeho použitia, odporúčame vám, aby ste si najskôr prečítali článok Prehľad funkcií rozhrania API pre Learn Catalog.

Proces, ktorý si prejdeme na vysokej úrovni, je:

  1. Dotazovanie rozhrania API pre Katalóg Learn
  2. Kontrola počiatočnej odpovede
  3. "Prettify" odpoveď
  4. Konvertujte ho na tabuľkový hárok
  5. Vyskúšanie ďalších dotazov

Keď začnete používať rozhranie API pre Learn Catalog pre svoje vlastné potreby, môžete mierne upraviť tieto kroky pre svoju požadovanú množinu nástrojov alebo potreby, ale vo všeobecnosti je proces používania rovnaký pre všetky prípady použitia.

Požiadavky

Ak chcete postupovať podľa krokov v tomto článku, budete potrebovať kučier a Visual Studio Code, dva populárne bezplatné nástroje na dotazovanie rozhraní API.

  • Ak už máte nainštalovanú aplikáciu Curl a Visual Studio Code, môžete prejsť na časť Rozhranie API pre Dotaz pre Katalóg Learn.
  • Ak ich nemáte nainštalované, postupujte podľa pokynov v nasledujúcich sekciách.

Stiahnutie a nastavenie sýtosti

curl je populárny, bezplatný nástroj typu open-source, príkazový riadok, ktorý môže dotazovať rozhrania API.

  1. Prejdite na stránku sťahovania stáí a stiahnite si balík použiteľný pre vaše prostredie. Ak si nie ste istí, ktorú z nich máte vybrať, použite sprievodcu sťahovaním.
  2. Nainštalujte aplikáciu a postupujte podľa pokynov na konfiguráciu. Pre tento článok alebo dotazovanie rozhrania API služby Learn Catalog nie sú potrebné žiadne jedinečné nastavenia.

Stiahnutie a nastavenie programu Visual Studio Code

Visual Studio Code je bezplatný výkonný editor kódu, ktorý vytvorila spoločnosť Microsoft.

  1. Prejdite na lokalitu Visual Studio Code a stiahnite si balík platný pre vaše prostredie.
  2. Nainštalujte aplikáciu a postupujte podľa pokynov na konfiguráciu.

Dotazovanie rozhrania API pre Katalóg Learn

Keďže na používanie rozhrania API pre Katalóg Learn nie je potrebné žiadne overovanie, môžete koncový bod rozhrania API dotazovať z ľubovoľného príkazového riadka, ktorý je povolený kulmom. Na účely tohto cvičenia použijeme terminál v rámci programu Visual Studio Code.

  1. Otvorte Visual Studio Code.
  2. V hornom navigačnom paneli vyberte položku Terminal( Terminál).
  3. Výberom položky Nový terminál otvorte nový terminál príkazov.
  4. Vyberte si terminál výberu (Bash, CMD atď.) a zadajte nižšie uvedený príkaz. Nižšie uvedený príkaz označuje, že chce použiť kučier, volať nefiltrovaný koncový bod rozhrania API služby Learn Catalog a výstupom bude odpoveď na súbor s názvom output.json v umiestnení definovanom v prípone súboru zobrazenom v termináli (napr. C:\Users\<username>):
curl https://learn.microsoft.com/api/catalog >> output.json
  1. Ak bola žiadosť úspešná, mali by sa vám zobraziť informácie o celkovej veľkosti súboru, napríklad 13,1 M (veľkosť sa môže zmeniť v závislosti od veľkosti odpovede). Ak bol neúspešný, mala by sa zobraziť chyba.

Poznámka

Po dokončení používania súboru output.json by ste ho mali odstrániť, alebo ho premenovať, aby bol použiteľnejší. Ak znova vytvoríte dotaz na rozhranie API pomocou rovnakého názvu súboru, pripojí sa odpoveď v rámci existujúceho súboru. Ďalšou možnosťou je pomenovať súbor jedinečnejším počas príkazu počiatočného dotazu, ako napríklad "output-1212.json" alebo "output-de-de-2022-12-12.json".

Kontrola počiatočnej odpovede

Počiatočná odpoveď je vo formáte JSON a bude "minimalizovaná", čo znamená, že určité medzery, riadky a karty sa odstránia, aby sa súbor zmenšil.

  1. V programe Visual Studio Code vyberte položku Súbor.
  2. Vyberte položku Otvoriť súbor.
  3. Prejdite na súbor output.json, ktorý bol vytvorený ako súčasť predchádzajúcej časti.

Táto minimizácia je štandardným postupom a súbor môže byť "predkcifikovaný", aby bol čitateľnejší príkazom v programe Visual Studio Code, čo urobíme v ďalšej časti.

Zjednotenie odpovede

  1. Keď máte súbor output.json otvorený v programe Visual Studio Code, použite kombináciu klávesov Ctrl + Shift + I.

Kód JSON by sa mal aktualizovať tak, aby bol rozdelený do viacerých riadkov a mal by byť vo formáte, ktorý je čitateľnejší. Informácie o rôznych vlastnostiach a hodnotách v rámci odpovede nájdete v článku Príručka pre vývojárov rozhraní API pre Learn Catalog pre slovník údajov.

Konverzia odpovede na tabuľkový hárok

Existuje mnoho ľudí, ktorí používajú rozhranie API služby Learn Catalog na jednotlivé úlohy alebo kontroly, a nie na ich integráciu do systému. V týchto prípadoch použitia môže byť užitočné skonvertovať odpoveď JSON na formát CSV alebo Excel, aby sa zobrazil ako tabuľkový hárok. Môžete použiť ľubovoľný preferovaný nástroj na konverziu, ale tu môžeme použiť Flatfile Json na CSV menič.

  1. Prejdite na: https://csvjson.com/json2csv.
  2. Nahrajte výstupný súbor.
  3. Vyberte položku Konvertovať.
  4. Vyberte položku Stiahnuť.

Poznámka

Na konvertovanie údajov používajte externé online nástroje veľmi opatrne a zvážte, aké údaje do nich dávate. V prípade rozhrania API pre Learn Catalog je odpoveď verejne dostupná a nevyžaduje overovanie, takže je v poriadku použiť online nástroj, ktorý pomôže s konverziou formátu.

Vyskúšanie ďalších dotazov

Pomocou krokov uvedených vyššie vyskúšajte ďalšie dotazy, napríklad tie, ktoré sú uvedené nižšie. Pozrite si, ako sa veľkosť súboru odpovede mení pre každú z nich a aký je rozdiel v objektoch, v ktorých sa nachádza.

Description Query
Všetky položky v rozhraní API pre Learn Catalog https://learn.microsoft.com/api/catalog/
Všetky španielske moduly https://learn.microsoft.com/api/catalog/?locale=es-es&type=modules
Všetky moduly so skóre popularity 0,9 alebo viac https://learn.microsoft.com/api/catalog/?type=modules&popularity>0.9
Všetky školenia o zabezpečení a objekty certifikácie pre začiatočníkov https://learn.microsoft.com/api/catalog/?level=beginner&subject=security
Všetky pokročilé moduly na zjednodušenie ovládania s skóre popularity viac ako 0,5 a aktualizované za posledný mesiac https://learn.microsoft.com/api/catalog/?level=advanced&subject=accessibility&popularity>0.5&last_modified=gte 2022-10-01

Ďalšie kroky

Odporúčame vám prezrieť si zdroje uvedené nižšie, aby sme vám pomohli na vašej ceste k vývoju: