API iškvietimas naudojant VS Code yra paprastas, tiesiog įdiekite vieną plėtinį ir jums nereikės pasikliauti jokiais išoriniais įrankiais, kad atliktumėte darbą.

Kūrimo metu dažnai pateikiate užklausas API. Tai gali būti išorinė API arba jūsų vidinio serverio API.

API skambučiams atlikti galite naudoti trečiųjų šalių įrankius, pvz., „Postman“. Tačiau VS kodo plėtinys leidžia skambinti API tiesiai iš VS kodo. Čia sužinosite, kaip atlikti API užklausas naudojant „VS Code“.

VS Code REST kliento plėtinys

VS Code plėtinys yra įskiepis arba priedas, patobulinantis Visual Studio kodo rengyklės funkcijas. VS Code plėtinių rinka siūlo kelių tipų plėtinius, kurie gali padėti atlikti programavimo užduotis. Yra kalbos palaikymo papildymas. Yra vienas, skirtas teikti automatinį užbaigimą konkrečiai programavimo kalbai ir pan. Plėtiniai palengvina programavimą naudojant VS kodą.

REST Client plėtinys leidžia vykdyti API užklausas iš VS kodo. Plėtinyje yra REST API redaktorius, vaizdinė sąsaja, leidžianti pateikti užklausą dėl API galinių taškų. Jis priima pasirinktines antraštes, užklausos parametrus ir kai kuriuos kitus parametrus.

instagram viewer

Norėdami įdiegti REST klientas, atidarykite „VS Code“ ir spustelėkite Plėtiniai skirtuką. Ieškoti REST klientas ir spustelėkite Diegti mygtuką, kad pridėtumėte jį prie VS kodo.

Pagal Detalės skirtuke, rasite naudingą mokymo programą, kaip naudoti klientą API užklausoms teikti. Pažiūrėkime į keturis dažniausiai pasitaikančius užklausų tipus ir kaip jas pateikti naudojant REST Client plėtinį.

Mes naudosime JSONPlaceholder parodyti, kaip atlikti API skambučius naudojant REST kliento plėtinį. Jame pateikiami šeši bendri ištekliai, kuriuos galite skaityti, redaguoti, atnaujinti arba ištrinti pateikdami API užklausas.

GET užklausos pateikimas naudojant REST kliento plėtinį

Pradėkite kurdami a .http failą API užklausoms. Galite pavadinti failą mano užklausos.http.

Pridėkite šį kodą prie savo mano užklausos.http failą, kad gautumėte išteklius iš JSONPlaceholder API, kurio ID yra 1:

GAUTI https://jsonplaceholder.typicode.com/posts/1 HTTP/1.1

Norėdami išsiųsti užklausą, spustelėkite Išsiųsti prašmą mygtuką, kuris rodomas failo viršuje. Atsidarys naujas langas su išsamia atsakymo informacija.

Taip pateikiate GET užklausą „VS Code“.

POST užklausos pateikimas naudojant REST kliento plėtinį

POST užklausą pateikiate, kai norite paskelbti duomenis į serverį, paprastai norėdami sukurti naują šaltinį.

Norėdami sukurti naują išteklių JSONPlaceholder API, pakeiskite kodą savo mano užklausos.http failą su tokia informacija:

PAST https://jsonplaceholder.typicode.com/posts HTTP/1.1
Turinio tipas: „application/json“
{
 "title": "foo",
 "body": "baras",
 "naudotojo ID": 1
}

Spustelėkite Išsiųsti prašmą mygtuką, kad išsiųstumėte užklausą. Vėlgi, bus atidarytas naujas langas su atsakymo duomenimis. Atsakymas rodo an HTTP/1.1 201 Sukurta pranešimą ir įrašo ID kartu su kitais duomenimis, jei API skambutis sėkmingas.

{
 "id": "101"
}

PUT užklausos pateikimas naudojant REST kliento plėtinį

Jūs pateikiate PUT užklausą, kai norite atnaujinti duomenis serveryje.

Norėdami atnaujinti esamą išteklius JSONPlaceholder API, pakeiskite kodą savo mano užklausos.http failą su tokia informacija:

PUT https://jsonplaceholder.typicode.com/posts/1 HTTP/1.1
Turinio tipas: „application/json“
{
 "title": "new foo",
 "body": "nauja juosta",
 "naudotojo ID": 1
}

Išsiuntus užklausą, išteklius bus atnaujintas netikrame serveryje ir gausite HTTP/1.1 200 Gerai žinutę.

PATCH užklausos pateikimas naudojant REST kliento plėtinį

PATCH užklausą pateikiate, kai norite modifikuoti tam tikrą serverio resurso lauką arba ypatybę.

Norėdami atnaujinti tik esamo šaltinio pavadinimą netikrame serveryje, pakeiskite kodą savo mano užklausos.http failą su tokia informacija:

https://jsonplaceholder.typicode.com/posts/1 HTTP/1.1 
Turinio tipas: „application/json“
{
 "title": "kitas foo"
}

Kai pateiksite užklausą, šaltinio pavadinimas bus atnaujintas netikrame serveryje ir gausite HTTP/1.1 200 Gerai pranešimą kartu su kitais šaltinio duomenimis.

Ištrinti užklausą naudojant REST kliento plėtinį

Jūs pateikiate DELETE užklausą, kai norite ištrinti išteklius serveryje.

Norėdami ištrinti esamą išteklius netikrame serveryje, pakeiskite kodą savo mano užklausos.http failą su tokia informacija:

IŠTRINTI https://jsonplaceholder.typicode.com/posts/1 HTTP/1.1

Čia, Turinio tipas nėra būtinas ir duomenų objektas. Jei išsiųsite užklausą ir sėkmingai ištrinsite išteklius, turėtumėte gauti pranešimą HTTP/1.1 200 Gerai atsakymas tuščiu objektu.

Skambinkite API tiesiai iš VS kodo

Anksčiau galbūt naudojote trečiųjų šalių įrankius, pvz Paštininkas teikti API užklausas. Nors šie įrankiai puikiai atlieka savo darbą, jų nustatymas užtrunka. Pavyzdžiui, norėdami naudoti API naršyklę, turite turėti paskyrą „Postman“.

Nors yra keletas internetinių API testavimo įrankių, tačiau naudojant tokius plėtinius kaip REST Client, API testavimas yra daug greitesnis ir lengvesnis. Galite išbandyti bet kurią API tiesiai iš savo VS kodo rengyklės. Tai ypač naudinga, jei kuriate API vietoje ir norite išbandyti vietines API.

Kiti API testavimo VS kodo plėtiniai

„Rest Client“ lengva naudotis. Tačiau tai nėra vienintelis VS kodo plėtinys, skirtas išbandyti API. Kitos populiarios parinktys yra „Thunder Client“, „httpYak“ ir „httpBook“.

„Thunder Client“ suteikia vaizdinį API rengyklę, kad supaprastintų API užklausas. Žinoma, norint naudoti šiuos įrankius, reikia žinoti, kas yra REST API.