Jak provádět volání REST API zevnitř kódu VS

Během vývoje je běžné, že zadáváte požadavky na API. Může to být pro nějaké externí API nebo API vašeho vlastního backendového serveru.

K provádění volání API můžete použít nástroje třetích stran, jako je Postman. Ale rozšíření VS Code vám umožňuje volat API přímo z VS Code. Zde se dozvíte, jak provádět požadavky API ve VS Code.

Rozšíření klienta VS Code REST

Rozšíření ve VS Code je plugin nebo doplněk, který vylepšuje funkce editoru kódu Visual Studio. Trh rozšíření VS Code nabízí několik typů rozšíření, která vám mohou pomoci s vašimi programovacími úkoly. Existuje rozšíření pro přidání jazykové podpory. Existuje jeden pro poskytování automatického dokončování pro konkrétní programovací jazyk a tak dále. Rozšíření usnadňují programování pomocí VS Code.

Rozšíření klienta REST umožňuje spouštět požadavky API z kódu VS. Rozšíření obsahuje editor REST API, vizuální rozhraní, které umožňuje dotazovat koncové body API. Přijímá vlastní záhlaví, parametry dotazu a některé další parametry.

Chcete-li nainstalovat Klient REST, otevřete VS Code a klikněte na Rozšíření tab. Hledat Klient REST a klikněte na Nainstalujte tlačítko pro přidání do kódu VS.

Pod Podrobnosti naleznete užitečný návod, jak používat klienta k vytváření požadavků API. Podívejme se na čtyři běžné typy požadavků a na to, jak je provést pomocí rozšíření REST Client.

Budeme používat JSONPlaceholder demonstrovat volání API pomocí rozšíření REST Client. Poskytuje šest běžných zdrojů, které můžete číst, upravovat, aktualizovat nebo mazat pomocí požadavků API.

Odeslání požadavku GET pomocí klientského rozšíření REST

Začněte vytvořením a .http soubor pro vaše požadavky API. Soubor můžete pojmenovat myrequests.http.

Přidejte následující kód do svého myrequests.http soubor k načtení prostředku z JSONPlaceholder API, který má jako ID 1:

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

Chcete-li požadavek odeslat, klikněte na Poslat žádost tlačítko, které se zobrazí v horní části souboru. Otevře se nové okno, které obsahuje podrobnosti o odpovědi.

Takto vytvoříte požadavek GET uvnitř kódu VS.

Vytvoření požadavku POST pomocí rozšíření klienta REST

Požadavek POST provedete, když chcete odeslat data na server, obvykle za účelem vytvoření nového prostředku.

Chcete-li vytvořit nový prostředek v rozhraní API JSONPlaceholder, nahraďte kód ve svém myrequests.http soubor s následujícím:

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

Klikněte na Poslat žádost tlačítko pro odeslání požadavku. Znovu se tím otevře nové okno obsahující data odezvy. Odpověď ukazuje an HTTP/1.1 201 Vytvořeno zprávu a ID příspěvku spolu s dalšími údaji, pokud je volání API úspěšné.

{
 "id": "101"
}

Odeslání požadavku PUT pomocí rozšíření klienta REST

Požadavek PUT provedete, když chcete aktualizovat data na serveru.

Chcete-li aktualizovat existující prostředek v rozhraní API JSONPlaceholder, nahraďte kód ve svém myrequests.http soubor s následujícím:

DÁT https://jsonplaceholder.typicode.com/posts/1 HTTP/1.1
Content-Type: "application/json"
{
 "title": "new foo",
 "body": "nový bar",
 "userId": 1
}

Po odeslání požadavku bude zdroj aktualizován na simulovaném serveru a dostanete zprávu HTTP/1.1 200 OK zpráva.

Vytvoření požadavku PATCH pomocí rozšíření klienta REST

Požadavek PATCH provedete, když chcete upravit určité pole nebo vlastnost daného prostředku na serveru.

Chcete-li aktualizovat pouze název existujícího zdroje na falešném serveru, nahraďte kód ve svém myrequests.http soubor s následujícím:

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

Po zadání požadavku bude název zdroje aktualizován na simulovaném serveru a dostanete zprávu HTTP/1.1 200 OK zprávu spolu s ostatními daty zdroje.

Vytvoření požadavku DELETE pomocí rozšíření klienta REST

Požadavek DELETE provedete, když chcete odstranit prostředek na serveru.

Chcete-li odstranit existující prostředek na simulovaném serveru, nahraďte kód ve svém myrequests.http soubor s následujícím:

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

Tady, Typ obsahu není vyžadován, stejně jako datový objekt. Pokud odešlete požadavek a úspěšně smažete zdroj, měli byste dostat HTTP/1.1 200 OK odpověď s prázdným objektem.

Provádějte volání API přímo zevnitř kódu VS

Dříve jste možná používali nástroje třetích stran jako např Pošťák, aby dělal požadavky API. I když tyto nástroje plní svou práci dobře, jejich nastavení zabere čas. Chcete-li například používat průzkumníka API, musíte mít účet u Postmana.

I když existují několik online testovacích nástrojů API, ale s rozšířeními, jako je klient REST, je testování API mnohem rychlejší a jednodušší. Jakékoli API můžete otestovat přímo z editoru kódu VS. To je zvláště užitečné, pokud vyvíjíte rozhraní API lokálně a chcete svá místní rozhraní API testovat za chodu.

Další rozšíření API Testing VS Code

Rest Client se snadno používá. Není to však jediné rozšíření VS Code pro testování API. Další oblíbené možnosti jsou Thunder Client, httpYak a httpBook.

Thunder Client poskytuje vizuální editor API pro zjednodušení požadavků API. Abyste tyto nástroje mohli používat, musíte samozřejmě vědět, co je REST API.