API-kutsun soittaminen VS Codessa on helppoa. Asenna vain yksi laajennus, niin sinun ei tarvitse luottaa ulkoisiin työkaluihin työn suorittamiseen.

Kehityksen aikana on tavallista, että teet pyyntöjä sovellusliittymille. Tämä voi liittyä johonkin ulkoiseen sovellusliittymään tai oman taustapalvelimesi sovellusliittymään.

Voit käyttää kolmannen osapuolen työkaluja, kuten Postmania, API-kutsujen suorittamiseen. Mutta VS-koodilaajennuksen avulla voit soittaa API-kutsuja suoraan VS-koodista. Täällä opit suorittamaan API-pyyntöjä VS Codessa.

VS Code REST -asiakaslaajennus

VS Coden laajennus on laajennus tai lisäosa, joka parantaa Visual Studio Code -editorin toimintoja. VS Code -laajennusten markkinapaikka tarjoaa useita erilaisia ​​laajennuksia, jotka voivat auttaa sinua ohjelmointitehtävissäsi. Kielituen lisäämistä varten on laajennus. On yksi, joka tarjoaa automaattisen täydennyksen tietylle ohjelmointikielelle ja niin edelleen. Laajennukset helpottavat ohjelmointia VS Coden kanssa.

REST Client -laajennuksen avulla voit suorittaa API-pyyntöjä VS-koodin sisällä. Laajennus sisältää REST API -editorin, visuaalisen käyttöliittymän, jonka avulla voit tehdä kyselyjä API-päätepisteistä. Se hyväksyy mukautetut otsikot, kyselyparametrit ja joitain muita parametreja.

instagram viewer

Asentaaksesi REST asiakas, avaa VS Code ja napsauta Laajennukset -välilehti. Etsiä REST asiakas ja napsauta Asentaa -painiketta lisätäksesi sen VS-koodiin.

Alla Yksityiskohdat -välilehdeltä löydät hyödyllisen opetusohjelman siitä, miten asiakassovellusta käytetään API-pyyntöjen tekemiseen. Katsotaanpa neljää yleistä pyyntötyyppiä ja kuinka ne tehdään REST Client -laajennuksella.

Tulemme käyttämään JSONPlaceholder havainnollistaa API-kutsujen soittamista REST-asiakaslaajennuksella. Se tarjoaa kuusi yleistä resurssia, joita voit lukea, muokata, päivittää tai poistaa tekemällä API-pyyntöjä.

GET-pyynnön tekeminen REST-asiakaslaajennuksen avulla

Aloita luomalla a .http tiedosto API-pyyntöjäsi varten. Voit nimetä tiedoston myrequests.http.

Lisää seuraava koodi omaan myrequests.http tiedosto resurssin hakemiseksi JSONPlaceholder API: sta, jonka tunnus on 1:

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

Lähetä pyyntö napsauttamalla Lähetä pyyntö -painiketta, joka näkyy tiedoston yläosassa. Näyttöön tulee uusi ikkuna, joka sisältää vastauksen tiedot.

Näin teet GET-pyynnön VS Coden sisällä.

POST-pyynnön tekeminen REST-asiakaslaajennuksella

Teet POST-pyynnön, kun haluat lähettää tietoja palvelimelle, yleensä luodaksesi uuden resurssin.

Voit luoda uuden resurssin JSONPlaceholder API: ssa korvaamalla koodin myrequests.http tiedosto seuraavalla:

LÄHETTÄÄ https://jsonplaceholder.typicode.com/posts HTTP/1.1
Sisältötyyppi: "sovellus/json"
{
 "title": "foo",
 "body": "baari",
 "käyttäjätunnus": 1
}

Klikkaa Lähetä pyyntö -painiketta lähettääksesi pyynnön. Jälleen tämä avaa uuden ikkunan, joka sisältää vastaustiedot. Vastauksessa näkyy an HTTP/1.1 201 Luotu viesti ja viestin tunnus sekä muut tiedot, jos API-kutsu onnistuu.

{
 "id": "101"
}

PUT-pyynnön tekeminen REST-asiakaslaajennuksella

Teet PUT-pyynnön, kun haluat päivittää palvelimen tietoja.

Voit päivittää olemassa olevan resurssin JSONPlaceholder API: ssa korvaamalla koodin myrequests.http tiedosto seuraavalla:

LAITTAA https://jsonplaceholder.typicode.com/posts/1 HTTP/1.1
Sisältötyyppi: "sovellus/json"
{
 "title": "uusi foo",
 "body": "uusi baari",
 "käyttäjätunnus": 1
}

Pyynnön lähettämisen jälkeen resurssi päivitetään valepalvelimelle ja saat HTTP/1.1 200 OK viesti.

PATCH-pyynnön tekeminen REST-asiakaslaajennuksella

Teet PATCH-pyynnön, kun haluat muokata palvelimella olevan resurssin tiettyä kenttää tai ominaisuutta.

Jos haluat päivittää vain olemassa olevan resurssin otsikon valepalvelimessa, vaihda koodi omassasi myrequests.http tiedosto seuraavalla:

https://jsonplaceholder.typicode.com/posts/1 HTTP/1.1 
Sisältötyyppi: "sovellus/json"
{
 "title": "toinen foo"
}

Kun olet tehnyt pyynnön, resurssin otsikko päivitetään valepalvelimelle ja saat HTTP/1.1 200 OK viesti yhdessä muiden resurssin tietojen kanssa.

DELETE-pyynnön tekeminen REST-asiakaslaajennuksella

Teet DELETE-pyynnön, kun haluat poistaa resurssin palvelimelta.

Jos haluat poistaa olemassa olevan resurssin valepalvelimelta, vaihda koodi omassasi myrequests.http tiedosto seuraavalla:

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

Tässä, Sisältötyyppi ei vaadita, eikä myöskään tietoobjekti. Jos lähetät pyynnön ja poistat resurssin onnistuneesti, sinun pitäisi saada HTTP/1.1 200 OK vastaus tyhjällä objektilla.

Tee API-kutsuja suoraan VS-koodin sisältä

Aiemmin olet saattanut käyttää kolmannen osapuolen työkaluja, kuten Postimies tehdä API-pyyntöjä. Vaikka nämä työkalut tekevät työn hyvin, niiden käyttöönotto vie aikaa. Sinulla on esimerkiksi oltava tili Postmanissa, jotta voit käyttää API Exploreria.

Vaikka niitä on useita online-API-testaustyökaluja, mutta laajennuksilla, kuten REST Client, sovellusliittymien testaus on paljon nopeampaa ja helpompaa. Voit testata mitä tahansa API-sovellusliittymää suoraan VS-koodieditoristasi. Tämä on erityisen hyödyllistä, jos kehität sovellusliittymiä paikallisesti ja haluat testata paikallisia sovellusliittymiäsi lennossa.

Muut API Testing VS Code Extensions

Rest Client on helppokäyttöinen. Mutta se ei ole ainoa VS-koodilaajennus API-testaukseen. Muita suosittuja vaihtoehtoja ovat Thunder Client, httpYak ja httpBook.

Thunder Client tarjoaa visuaalisen API-editorin API-pyyntöjen yksinkertaistamiseksi. Tietenkin sinun on tiedettävä, mikä REST API on käyttääksesi näitä työkaluja.