Kako narediti klice REST API iz kode VS

Med razvojem je običajno, da zahtevate API-je. To je lahko zunanji API ali API vašega lastnega zalednega strežnika.

Za izvajanje klicev API lahko uporabite orodja tretjih oseb, kot je Postman. Toda razširitev VS Code vam omogoča, da kličete API neposredno znotraj VS Code. Tukaj se boste naučili izvajati zahteve API v kodi VS.

Razširitev odjemalca kode VS REST

Razširitev v kodi VS je vtičnik ali dodatek, ki izboljša funkcionalnosti urejevalnika kode Visual Studio. Tržnica razširitev VS Code ponuja več vrst razširitev, ki vam lahko pomagajo pri programskih nalogah. Obstaja razširitev za dodajanje jezikovne podpore. Obstaja ena za zagotavljanje samodokončanja za določen programski jezik in tako naprej. Razširitve olajšajo programiranje s kodo VS.

Razširitev odjemalca REST vam omogoča izvajanje zahtev API iz kode VS. Razširitev vključuje urejevalnik REST API, vizualni vmesnik, ki vam omogoča poizvedovanje po končnih točkah API-ja. Sprejema glave po meri, poizvedbene parametre in nekatere druge parametre.

Za namestitev Odjemalec REST, odprite kodo VS in kliknite na Razširitve zavihek. Išči Odjemalec REST in kliknite Namestite gumb, da ga dodate v kodo VS.

Pod Podrobnosti boste našli uporabno vadnico o uporabi odjemalca za izdelavo zahtev API. Oglejmo si štiri običajne vrste zahtev in kako jih narediti z razširitvijo odjemalca REST.

Uporabljali bomo JSONPlaceholder za prikaz klicev API z uporabo razširitve odjemalca REST. Ponuja šest pogostih virov, ki jih lahko berete, urejate, posodabljate ali brišete z zahtevami API-ja.

Izdelava zahteve GET z uporabo razširitve odjemalca REST

Začnite z ustvarjanjem a .http datoteko za vaše zahteve API. Datoteko lahko poimenujete moje zahteve.http.

Svoji dodajte naslednjo kodo moje zahteve.http datoteko za pridobitev vira iz API-ja JSONPlaceholder, ki ima ID 1:

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

Če želite poslati zahtevo, kliknite na Pošlji zahtevo gumb, ki se prikaže na vrhu datoteke. Odpre se novo okno s podrobnostmi o odgovoru.

Tako naredite zahtevo GET znotraj kode VS.

Izdelava zahteve POST z uporabo razširitve odjemalca REST

Zahtevo POST naredite, ko želite objaviti podatke na strežniku, običajno za ustvarjanje novega vira.

Če želite ustvariti nov vir v API-ju JSONPlaceholder, zamenjajte kodo v svojem moje zahteve.http datoteka z naslednjim:

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

Kliknite na Pošlji zahtevo gumb za pošiljanje zahteve. Ponovno se bo odprlo novo okno s podatki o odgovoru. Odgovor kaže na HTTP/1.1 201 Ustvarjen sporočilo in ID objave skupaj z drugimi podatki, če je klic API uspešen.

{
 "id": "101"
}

Izdelava zahteve PUT z uporabo razširitve odjemalca REST

Zahtevo PUT naredite, ko želite posodobiti podatke na strežniku.

Če želite posodobiti obstoječi vir v API-ju JSONPlaceholder, zamenjajte kodo v svojem moje zahteve.http datoteka z naslednjim:

POSTAVITE https://jsonplaceholder.typicode.com/posts/1 HTTP/1.1
Content-Type: "application/json"
{
 "naslov": "novo foo",
 "body": "nova vrstica",
 "userId": 1
}

Po pošiljanju zahteve bo vir posodobljen na lažnem strežniku in prejeli boste HTTP/1.1 200 OK sporočilo.

Izdelava zahteve PATCH z uporabo odjemalske razširitve REST

Zahtevo PATCH naredite, ko želite spremeniti določeno polje ali lastnost danega vira na strežniku.

Če želite posodobiti samo naslov obstoječega vira v lažnem strežniku, zamenjajte kodo v svojem moje zahteve.http datoteka z naslednjim:

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

Ko podate zahtevo, bo naslov vira posodobljen na lažnem strežniku in prejeli boste HTTP/1.1 200 OK sporočilo skupaj z drugimi podatki vira.

Izdelava zahteve DELETE z uporabo razširitve odjemalca REST

Zahtevo DELETE naredite, ko želite izbrisati vir na strežniku.

Če želite izbrisati obstoječi vir v lažnem strežniku, zamenjajte kodo v svojem moje zahteve.http datoteka z naslednjim:

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

Tukaj, Vrsta vsebine ni potreben, prav tako pa ni podatkovni objekt. Če pošljete zahtevo in uspešno izbrišete vir, bi morali prejeti HTTP/1.1 200 OK odgovor s praznim predmetom.

Opravite klice API neposredno iz kode VS

Prej ste morda uporabljali orodja tretjih oseb, kot je Poštar za API zahteve. Čeprav ta orodja dobro opravljajo svoje delo, je potreben čas, da jih nastavite. Na primer, za uporabo API Explorerja morate imeti račun pri Postmanu.

Čeprav obstajajo več spletnih orodij za testiranje API-jev, vendar je z razširitvami, kot je odjemalec REST, testiranje API-jev veliko hitrejše in enostavnejše. Kateri koli API lahko preizkusite neposredno v urejevalniku kode VS. To je še posebej uporabno, če API-je razvijate lokalno in želite svoje lokalne API-je preizkusiti sproti.

Drugo testiranje API VS razširitev kode

Rest Client je enostaven za uporabo. Vendar to ni edina razširitev kode VS za testiranje API-jev. Druge priljubljene možnosti so Thunder Client, httpYak in httpBook.

Thunder Client ponuja vizualni urejevalnik API-jev za poenostavitev zahtev API-jev. Seveda morate za uporabo teh orodij vedeti, kaj je REST API.