Att ringa ett API-anrop inom VS Code är enkelt, installera bara ett tillägg och sedan behöver du inte förlita dig på några externa verktyg för att få jobbet gjort.

Under utvecklingen är det vanligt att du gör förfrågningar till API: er. Detta kan vara till något externt API eller din egen backend-servers API.

Du kan använda tredjepartsverktyg som Postman för att utföra dina API-anrop. Men en VS Code-tillägg låter dig göra API-anrop direkt inifrån VS Code. Här får du lära dig hur du utför API-förfrågningar i VS Code.

VS Code REST Client Extension

En tillägg i VS Code är ett plugin eller tillägg som förbättrar funktionerna i Visual Studio Code-redigeraren. Marknadsplatsen VS Code extensions tillhandahåller flera typer av tillägg som kan hjälpa dig med dina programmeringsuppgifter. Det finns en tillägg för att lägga till språkstöd. Det finns en för att tillhandahålla automatisk komplettering för ett specifikt programmeringsspråk och så vidare. Tillägg gör det lättare att programmera med VS Code.

instagram viewer

REST-klienttillägget låter dig utföra API-förfrågningar inifrån VS-koden. Tillägget inkluderar REST API-redigeraren, ett visuellt gränssnitt som låter dig fråga API-slutpunkter. Den accepterar anpassade rubriker, frågeparametrar och några andra parametrar.

För att installera REST-klient, öppna VS Code och klicka på Tillägg flik. Söka efter REST-klient och klicka på Installera knappen för att lägga till den i VS-koden.

Under Detaljer fliken, hittar du en användbar handledning om hur du använder klienten för att göra API-förfrågningar. Låt oss se de fyra vanliga typerna av förfrågningar och hur man gör dem med REST Client-tillägget.

Vi kommer att använda JSONPlatshållare för att visa att man gör API-anrop med REST-klienttillägget. Den tillhandahåller sex vanliga resurser som du kan läsa, redigera, uppdatera eller ta bort genom att göra API-förfrågningar.

Göra en GET-förfrågan med REST-klienttillägget

Börja med att skapa en .http fil för dina API-förfrågningar. Du kan namnge filen myrequests.http.

Lägg till följande kod till din myrequests.http fil för att hämta en resurs från JSONPlaceholder API med 1 som ID:

SKAFFA SIG https://jsonplaceholder.typicode.com/posts/1 HTTP/1.1

För att skicka begäran, klicka på Skicka förfrågan knappen som visas överst i filen. Ett nytt fönster öppnas som innehåller svarsdetaljerna.

Så här gör du en GET-förfrågan i VS-koden.

Göra en POST-förfrågan med REST-klienttillägget

Du gör en POST-begäran när du vill skicka data till servern, vanligtvis för att skapa en ny resurs.

För att skapa en ny resurs i JSONPlaceholder API, ersätt koden i din myrequests.http fil med följande:

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

Klicka på Skicka förfrågan knappen för att skicka begäran. Återigen kommer detta att öppna ett nytt fönster som innehåller svarsdata. Svaret visar en HTTP/1.1 201 Skapad meddelande och inläggets ID tillsammans med annan data om API-anropet lyckas.

{
 "id": "101"
}

Göra en PUT-förfrågan med REST-klienttillägget

Du gör en PUT-förfrågan när du vill uppdatera data på servern.

För att uppdatera en befintlig resurs i JSONPlaceholder API, byt ut koden i din myrequests.http fil med följande:

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

Efter att ha skickat begäran kommer resursen att uppdateras på skenservern och du får en HTTP/1.1 200 OK meddelande.

Göra en PATCH-förfrågan med REST-klienttillägget

Du gör en PATCH-begäran när du vill modifiera ett visst fält eller egenskap för en given resurs på servern.

För att bara uppdatera titeln på en befintlig resurs i skenservern, byt ut koden i din myrequests.http fil med följande:

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

När du har gjort begäran kommer resurstiteln att uppdateras på skenservern och du får en HTTP/1.1 200 OK meddelandet tillsammans med resursens övriga data.

Göra en DELETE-förfrågan med REST-klienttillägget

Du gör en DELETE-förfrågan när du vill ta bort en resurs på servern.

För att ta bort en befintlig resurs i skenservern, ersätt koden i din myrequests.http fil med följande:

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

Här, den Innehållstyp krävs inte, och inte heller dataobjektet. Om du skickar förfrågan och lyckas ta bort resursen bör du få en HTTP/1.1 200 OK svar med ett tomt objekt.

Gör API-anrop direkt från VS-koden

Tidigare kan du ha använt tredjepartsverktyg som Brevbärare för att göra API-förfrågningar. Även om dessa verktyg gör jobbet bra, tar det tid att installera dem. Du behöver till exempel ha ett konto hos Postman för att använda API-utforskaren.

Även om det finns flera online-API-testverktyg, men med tillägg som REST-klienten är det mycket snabbare och enklare att testa API: er. Du kan testa vilket API som helst direkt från din VS-kodredigerare. Detta är särskilt användbart om du utvecklar API: er lokalt och vill testa dina lokala API: er i farten.

Andra API-testning VS-kodtillägg

Rest Client är lätt att använda. Men det är inte det enda VS-kodtillägget för att testa API: er. Andra populära alternativ är Thunder Client, httpYak och httpBook.

Thunder Client tillhandahåller en visuell API-redigerare för att förenkla API-förfrågningar. Naturligtvis måste du veta vad REST API är för att använda dessa verktyg.