Microsoft Learnin hakemiston ohjelmointirajapinnan käytön aloittaminen curlin ja Visual Studio Coden avulla
Tässä artikkelissa kerrotaan, miten voit aloittaa Microsoft Learnin hakemiston ohjelmointirajapinnan käytön curlin ja Visual Studio Coden avulla. Jos et ole perehtynyt ohjelmointirajapinnan tietoihin tai sen käyttötapauksiin, suosittelemme, että tutustut ensin Learnin hakemiston ohjelmointirajapinnan yleiskatsaus -artikkeliin .
Korkean tason prosessi on seuraava:
- Kysely Learn-hakemiston ohjelmointirajapinnasta
- Tarkista ensimmäinen vastaus
- "Prettify" vastaus
- Sen muuntaminen laskentataulukoksi
- Kokeile lisää kyselyitä
Kun alat käyttää Learnin hakemiston ohjelmointirajapintaa omiin tarpeisiisi, saatat hieman muokata näitä vaiheita haluamasi työkaluvalikoiman tai tarpeiden mukaan, mutta yleensä käyttöprosessi on sama kaikissa käyttötapauksissa.
Edellytykset
Jotta voit noudattaa tämän artikkelin vaiheita, tarvitset curl-and Visual Studio Coden, kaksi suosittua, maksutonta työkalua ohjelmointirajapintojen kyselemiseen.
- Jos curl ja Visual Studio Code ovat jo asennettuna, voit siirtyä Eteenpäin Kysely oppimaan hakemiston ohjelmointirajapintaan -osioon.
- Jos niitä ei ole asennettu, noudata seuraavissa osioissa annettuja ohjeita.
Lataa ja määritä kihara
curl on suosittu, maksuton, avoimen lähdekoodin komentorivityökalu, joka voi tehdä kyselyjä ohjelmointirajapinnoista.
- Siirry curl Download Page -sivulle ja lataa ympäristöösi soveltuva paketti. Jos et ole varma, kumman valitset, käytä ohjattua curlin lataamista.
- Asenna sovellus ja määritä se noudattamalla kehotteita. Tähän artikkeliin tai Learnin hakemiston ohjelmointirajapinnan kyselyyn ei tarvita yksilöllisiä asetuksia.
Visual Studio Coden lataaminen ja määrittäminen
Visual Studio Code on Microsoftin luoma maksuton ja tehokas koodieditori.
- Siirry Visual Studio Code -sivustoon ja lataa ympäristöösi soveltuva paketti.
- Asenna sovellus ja määritä se noudattamalla kehotteita.
Kysely Learn-hakemiston ohjelmointirajapinnasta
Koska Learnin hakemiston ohjelmointirajapinnan käyttämiseen ei tarvita todennusta, voit tehdä kyselyn ohjelmointirajapinnan päätepisteeseen millä tahansa komentorivillä, jonka curl-ominaisuus on käytössä. Tässä harjoituksessa käytämme Visual Studio Coden päätetta.
- Avaa Visual Studio Code.
- Valitse yläreunan siirtymisruudusta Pääte.
- Avaa uusi komentopääte valitsemalla Uusi pääte.
- Valitse valintapääte (Bash, CMD jne.) ja kirjoita alla oleva komento. Alla oleva komento ilmaisee, että se haluaa käyttää curlia, kutsua suodattamatonta Learn-hakemiston ohjelmointirajapinnan päätepistettä ja tulostaa vastauksen tiedostoon nimeltä "output.json", joka on määritetty päätteessä näkyvässä tiedostopolussa (ex:
C:\Users\<username>
):
curl https://learn.microsoft.com/api/catalog >> output.json
- Jos pyyntö onnistui, sinun pitäisi nähdä tietoja tiedoston kokonaiskoosta, kuten 13,1 M (koko voi muuttua vastauksen koon mukaan). Jos se epäonnistui, sinun pitäisi saada virhe.
Muistiinpano
Poista output.json-tiedosto, kun olet käyttänyt sitä, tai nimeä se uudelleen, jotta se on soveltuvampi. Jos teet ohjelmointirajapinnasta kyselyn uudelleen käyttämällä samaa tiedostonimeä, se liittää vastauksen olemassa olevaan tiedostoon. Toinen vaihtoehto on nimetä tiedosto yksilöllisemmin ensimmäisen kyselykomennon aikana, kuten "output-1212.json" tai "output-de-de-2022-12-12.json".
Tarkista ensimmäinen vastaus
Ensimmäinen vastaus on JSON-muodossa ja se "pienennetään", mikä tarkoittaa, että tietyt välilyönnit, rivit ja välilehdet poistetaan tiedoston pienentämiseksi.
- Valitse Visual Studio Codessa Tiedosto.
- Valitse Avaa tiedosto.
- Siirry "output.json"-tiedostoon, joka luotiin osana edellistä osaa.
Tämä pienoissovellus on vakiokäytäntö, ja visual studio code -komennolla voit muokata tiedostoa luettavuuden helpottamiseksi. Tämän teemme seuraavassa osiossa.
Vastauksen valmisteleminen
- Kun "output.json"-tiedosto on avattuna Visual Studio Codessa, käytä Ctrl+Vaihto+I-näppäinyhdistelmää.
JSON-kohteen pitäisi päivittyä, jotta se jakautuu useisiin riveihin ja on helpommin luettavassa muodossa. Lisätietoja vastauksen ominaisuuksista ja arvoista on tietohakemiston Learnin hakemiston ohjelmointirajapinnan kehittäjän viiteartikkelissa .
Vastauksen muuntaminen laskentataulukoksi
Monet käyttäjät käyttävät Learn-hakemiston ohjelmointirajapintaa yksittäisissä tehtävissä tai tarkistamisessa sen sijaan, että he integroivat sen järjestelmään. Näissä käyttötapauksissa voi olla hyödyllistä muuntaa JSON-vastaus CSV- tai Excel-muotoon, jotta sitä voidaan tarkastella laskentataulukona. Voit käyttää mitä tahansa haluamaasi muuntamistyökalua, mutta tässä voimme käyttää Flatfile Json -muunninta CSV-muuntimeen.
- Siirry osoitteeseen: https://csvjson.com/json2csv.
- Lataa tulostetiedosto.
- Valitse Muunna.
- Valitse Lataa.
Muistiinpano
Käytä erittäin varoen ulkoisia verkkotyökaluja tietojen muuntamiseen ja harkitse, mitä tietoja käytät niihin. Learnin hakemiston ohjelmointirajapinnan tapauksessa vastaus on julkisesti saatavilla eikä se edellytä todentamista. Verkkotyökalun avulla voi siis muuntaa muotoa.
Kokeile lisää kyselyitä
Kokeile lisää kyselyitä noudattamalla yllä olevia ohjeita, kuten alla lueteltuja kyselyitä. Näet, miten vastaustiedoston koko muuttuu kunkin kohdalla ja miten ne eroavat objekteissa.
Kuvaus | Query |
---|---|
Kaikki Learnin hakemiston ohjelmointirajapinnan kohteet | https://learn.microsoft.com/api/catalog/ |
Kaikki espanjankieliset moduulit | https://learn.microsoft.com/api/catalog/?locale=es-es&type=modules |
Kaikki moduulit, joiden suosiopistemäärä on vähintään 0,9 | https://learn.microsoft.com/api/catalog/?type=modules&popularity>0.9 |
Kaikki aloittelijoiden suojauskoulutus- ja sertifiointiobjektit | https://learn.microsoft.com/api/catalog/?level=beginner&subject=security |
Kaikki edistyneiden helppokäyttötoimintojen moduulit, joiden suosiopistemäärä on yli 0,5 ja joita on päivitetty viimeisen kuukauden aikana | https://learn.microsoft.com/api/catalog/?level=advanced&subject=accessibility&popularity>0.5&last_modified=gte 2022-10-01 |
Seuraavat vaiheet
Suosittelemme, että tutustut alla oleviin resursseihin ja autat sinua kehitysmatkallasi: