Kako napraviti REST API pozive iz VS koda

Tijekom razvoja uobičajeno je da upućujete zahtjeve API-jima. To može biti neki vanjski API ili API vašeg vlastitog pozadinskog poslužitelja.

Možete koristiti alate trećih strana kao što je Postman za obavljanje API poziva. Ali VS Code ekstenzija vam omogućuje upućivanje API poziva izravno iz VS Codea. Ovdje ćete naučiti kako izvršiti API zahtjeve u VS kodu.

Ekstenzija VS Code REST klijenta

Proširenje u VS Codeu je dodatak ili dodatak koji poboljšava funkcionalnost uređivača Visual Studio Code. Tržište proširenja VS Code nudi nekoliko vrsta proširenja koja vam mogu pomoći u programskim zadacima. Postoji proširenje za dodavanje jezične podrške. Postoji jedan za pružanje automatskog dovršavanja za određeni programski jezik i tako dalje. Proširenja olakšavaju programiranje s VS kodom.

Proširenje REST klijenta omogućuje vam izvršavanje API zahtjeva unutar VS koda. Proširenje uključuje REST API editor, vizualno sučelje koje vam omogućuje postavljanje upita krajnjim točkama API-ja. Prihvaća prilagođena zaglavlja, parametre upita i neke druge parametre.

Za instaliranje REST klijent, otvorite VS Code i kliknite na Ekstenzije tab. Traziti REST klijent i kliknite na Instalirati gumb za dodavanje u VS kod.

Ispod pojedinosti kartici, pronaći ćete korisne upute o tome kako koristiti klijenta za upućivanje API zahtjeva. Pogledajmo četiri uobičajene vrste zahtjeva i kako ih napraviti pomoću proširenja REST klijenta.

Koristit ćemo se JSON rezervirano mjesto za demonstraciju upućivanja API poziva korištenjem proširenja REST klijenta. Omogućuje šest uobičajenih resursa koje možete čitati, uređivati, ažurirati ili brisati slanjem API zahtjeva.

Izrada GET zahtjeva korištenjem REST klijentske ekstenzije

Započnite stvaranjem a .http datoteku za vaše API zahtjeve. Datoteci možete dati naziv moji zahtjevi.http.

Dodajte sljedeći kôd svom moji zahtjevi.http datoteku za dohvaćanje resursa iz JSONPlaceholder API-ja koji ima 1 kao ID:

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

Za slanje zahtjeva kliknite na Pošalji zahtjev gumb koji se pojavljuje na vrhu datoteke. Otvorit će se novi prozor koji sadrži pojedinosti o odgovoru.

Ovako postavljate GET zahtjev unutar VS koda.

Izrada POST zahtjeva korištenjem REST klijentske ekstenzije

Zahtjev POST postavljate kada želite poslati podatke na poslužitelj, obično za stvaranje novog resursa.

Da biste stvorili novi resurs u API-ju JSONPlaceholder, zamijenite kôd u svom moji zahtjevi.http datoteka sa sljedećim:

POST https://jsonplaceholder.typicode.com/posts HTTP/1.1
Content-Type: "application/json"
{
 "naslov": "foo",
 "tijelo": "bar",
 "userId": 1
}

Kliknite na Pošalji zahtjev gumb za slanje zahtjeva. Opet, ovo će otvoriti novi prozor koji sadrži podatke o odgovoru. Odgovor pokazuje an HTTP/1.1 201 Stvoreno poruka i ID objave zajedno s drugim podacima ako je API poziv uspješan.

{
 "id": "101"
}

Izrada PUT zahtjeva korištenjem REST klijentske ekstenzije

Postavljate PUT zahtjev kada želite ažurirati podatke na poslužitelju.

Da biste ažurirali postojeći resurs u API-ju JSONPlaceholder, zamijenite kôd u svom moji zahtjevi.http datoteka sa sljedećim:

STAVITI https://jsonplaceholder.typicode.com/posts/1 HTTP/1.1
Content-Type: "application/json"
{
 "naslov": "novi foo",
 "tijelo": "nova traka",
 "userId": 1
}

Nakon slanja zahtjeva, resurs će se ažurirati na lažnom poslužitelju i dobit ćete HTTP/1.1 200 OK poruka.

Izrada PATCH zahtjeva korištenjem REST klijentske ekstenzije

Zahtjev PATCH postavljate kada želite izmijeniti određeno polje ili svojstvo određenog resursa na poslužitelju.

Da biste ažurirali samo naslov postojećeg resursa na lažnom poslužitelju, zamijenite kod u svom moji zahtjevi.http datoteka sa sljedećim:

https://jsonplaceholder.typicode.com/posts/1 HTTP/1.1 
Content-Type: "application/json"
{
 "naslov": "još jedan foo"
}

Nakon što napravite zahtjev, naslov resursa bit će ažuriran na lažnom poslužitelju i dobit ćete HTTP/1.1 200 OK poruku zajedno s ostalim podacima izvora.

Izrada zahtjeva za DELETE korištenjem REST klijentske ekstenzije

Zahtjev DELETE postavljate kada želite izbrisati resurs na poslužitelju.

Da biste izbrisali postojeći resurs na lažnom poslužitelju, zamijenite kôd u svom moji zahtjevi.http datoteka sa sljedećim:

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

Evo, Vrsta sadržaja nije potreban, kao ni objekt podataka. Ako pošaljete zahtjev i uspješno izbrišete resurs, trebali biste dobiti HTTP/1.1 200 OK odgovor s praznim objektom.

Učinite API pozive izravno iz VS koda

Prije ste možda koristili alate trećih strana kao što su Poštar za API zahtjeve. Iako ovi alati dobro obavljaju posao, potrebno je vrijeme za njihovo postavljanje. Na primjer, morate imati račun kod Postmana da biste koristili API explorer.

Iako postoje nekoliko mrežnih alata za testiranje API-ja, ali uz proširenja kao što je REST klijent, testiranje API-ja mnogo je brže i lakše. Možete testirati bilo koji API izravno iz uređivača VS koda. Ovo je posebno korisno ako lokalno razvijate API-je i želite testirati svoje lokalne API-je u hodu.

Ostala API testiranja VS proširenja koda

Rest Client je jednostavan za korištenje. No, to nije jedino VS Code proširenje za testiranje API-ja. Ostale popularne opcije su Thunder Client, httpYak i httpBook.

Thunder Client nudi vizualni API editor za pojednostavljenje API zahtjeva. Naravno, morate znati što je REST API da biste koristili ove alate.