Uskutočnenie volania API v rámci VS Code je hračka, stačí nainštalovať jedno rozšírenie a potom sa pri dokončení úlohy nebudete musieť spoliehať na žiadne externé nástroje.

Počas vývoja je bežné, že zadávate požiadavky na rozhrania API. Môže to byť pre niektoré externé API alebo API vášho vlastného backendového servera.

Na uskutočnenie volaní API môžete použiť nástroje tretích strán, ako je Postman. Rozšírenie VS Code vám však umožňuje uskutočňovať volania API priamo z kódu VS. Tu sa dozviete, ako vykonávať požiadavky API v kóde VS.

Rozšírenie klienta VS Code REST

Rozšírenie vo VS Code je doplnok alebo doplnok, ktorý vylepšuje funkcie editora kódu Visual Studio. Trh rozšírení VS Code poskytuje niekoľko typov rozšírení, ktoré vám môžu pomôcť s vašimi programovacími úlohami. Existuje rozšírenie pre pridanie jazykovej podpory. Existuje jeden na poskytovanie automatického dokončovania pre konkrétny programovací jazyk atď. Rozšírenia uľahčujú programovanie pomocou kódu VS.

Rozšírenie REST Client vám umožňuje vykonávať požiadavky API z kódu VS. Rozšírenie obsahuje editor REST API, vizuálne rozhranie, ktoré vám umožňuje dotazovať sa na koncové body API. Prijíma vlastné hlavičky, parametre dopytu a niektoré ďalšie parametre.

instagram viewer

Ak chcete nainštalovať Klient REST, otvorte VS kód a kliknite na Rozšírenia tab. Hľadať Klient REST a kliknite na Inštalácia tlačidlo na pridanie do kódu VS.

Pod Podrobnosti nájdete užitočný návod, ako používať klienta na vytváranie požiadaviek API. Pozrime sa na štyri bežné typy požiadaviek a ako ich vykonať pomocou rozšírenia REST Client.

Budeme používať JSONPlaceholder demonštrovať uskutočňovanie volaní API pomocou rozšírenia REST Client. Poskytuje šesť bežných zdrojov, ktoré môžete čítať, upravovať, aktualizovať alebo odstraňovať zadaním požiadaviek API.

Vytvorenie požiadavky GET pomocou rozšírenia klienta REST

Začnite vytvorením a .http súbor pre vaše požiadavky API. Súbor môžete pomenovať myrequests.http.

Pridajte nasledujúci kód do svojho myrequests.http súbor na načítanie zdroja z JSONPlaceholder API s 1 ako jeho ID:

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

Ak chcete odoslať žiadosť, kliknite na Poslať žiadosť tlačidlo, ktoré sa zobrazí v hornej časti súboru. Otvorí sa nové okno, ktoré obsahuje podrobnosti o odpovedi.

Takto vytvoríte požiadavku GET v kóde VS.

Vytvorenie požiadavky POST pomocou rozšírenia klienta REST

Požiadavku POST zadáte, keď chcete odoslať údaje na server, zvyčajne na vytvorenie nového prostriedku.

Ak chcete vytvoriť nový zdroj v JSONPlaceholder API, nahraďte kód vo svojom myrequests.http súbor s nasledujúcim:

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

Kliknite na Poslať žiadosť tlačidlo na odoslanie žiadosti. Opäť sa tým otvorí nové okno s údajmi o odpovedi. Odpoveď ukazuje an HTTP/1.1 201 Vytvorené správu a ID príspevku spolu s ďalšími údajmi, ak je volanie API úspešné.

{
 "id": "101"
}

Vytvorenie požiadavky PUT pomocou rozšírenia klienta REST

Požiadavku PUT zadáte, keď chcete aktualizovať údaje na serveri.

Ak chcete aktualizovať existujúci zdroj v rozhraní API JSONPlaceholder, nahraďte kód vo svojom myrequests.http súbor s nasledujúcim:

PUT https://jsonplaceholder.typicode.com/posts/1 HTTP/1.1
Content-Type: "application/json"
{
 "title": "new foo",
 "body": "nová lišta",
 "userId": 1
}

Po odoslaní požiadavky bude zdroj aktualizovaný na falošnom serveri a dostanete HTTP/1.1 200 OK správu.

Vytvorenie požiadavky PATCH pomocou rozšírenia klienta REST

Požiadavku PATCH zadáte, keď chcete upraviť konkrétne pole alebo vlastnosť daného prostriedku na serveri.

Ak chcete aktualizovať iba názov existujúceho zdroja na simulovanom serveri, nahraďte kód vo svojom myrequests.http súbor s nasledujúcim:

https://jsonplaceholder.typicode.com/posts/1 HTTP/1.1 
Content-Type: "application/json"
{
 "title": "other foo"
}

Po zadaní požiadavky sa názov zdroja aktualizuje na falošnom serveri a dostanete HTTP/1.1 200 OK správu spolu s ostatnými údajmi zdroja.

Vytvorenie požiadavky VYMAZAŤ pomocou rozšírenia klienta REST

Požiadavku DELETE zadáte, keď chcete odstrániť prostriedok na serveri.

Ak chcete odstrániť existujúci zdroj na simulovanom serveri, nahraďte kód vo svojom myrequests.http súbor s nasledujúcim:

VYMAZAŤ https://jsonplaceholder.typicode.com/posts/1 HTTP/1.1

Tu, Druh obsahu nevyžaduje sa ani objekt údajov. Ak odošlete požiadavku a úspešne odstránite zdroj, mali by ste dostať HTTP/1.1 200 OK odpoveď s prázdnym objektom.

Uskutočňujte volania API priamo z vnútra kódu VS

Predtým ste možno používali nástroje tretích strán, ako napr Poštár dávať požiadavky API. Aj keď tieto nástroje vykonávajú svoju prácu dobre, ich nastavenie si vyžaduje čas. Ak chcete napríklad používať prieskumníka API, musíte mať účet u Postman.

Hoci existujú niekoľko online nástrojov na testovanie API, ale s rozšíreniami ako REST Client je testovanie API oveľa rýchlejšie a jednoduchšie. Akékoľvek API môžete otestovať priamo z editora kódu VS. Toto je obzvlášť užitočné, ak vyvíjate API lokálne a chcete testovať svoje lokálne API za behu.

Ďalšie rozšírenia testovania API VS kódu

Rest Client sa ľahko používa. Nie je to však jediné rozšírenie VS Code na testovanie API. Ďalšie populárne možnosti sú Thunder Client, httpYak a httpBook.

Thunder Client poskytuje vizuálny editor API na zjednodušenie požiadaviek API. Na používanie týchto nástrojov musíte samozrejme vedieť, čo je REST API.