Kā veikt REST API zvanus no VS koda iekšpuses

Izstrādes laikā jūs parasti iesniedzat pieprasījumus API. Tas varētu būt saistīts ar kādu ārēju API vai jūsu aizmugursistēmas servera API.

API zvanu veikšanai varat izmantot trešo pušu rīkus, piemēram, Postman. Taču VS koda paplašinājums ļauj veikt API zvanus tieši no VS koda. Šeit jūs uzzināsit, kā izpildīt API pieprasījumus programmā VS Code.

VS Code REST klienta paplašinājums

VS Code paplašinājums ir spraudnis vai papildinājums, kas uzlabo Visual Studio koda redaktora funkcijas. VS Code paplašinājumu tirgus piedāvā vairākus paplašinājumu veidus, kas var palīdzēt jums veikt programmēšanas uzdevumus. Ir paplašinājums valodas atbalsta pievienošanai. Ir viens automātiskās pabeigšanas nodrošināšanai noteiktai programmēšanas valodai un tā tālāk. Paplašinājumi atvieglo programmēšanu ar VS kodu.

REST Client paplašinājums ļauj izpildīt API pieprasījumus no VS koda. Paplašinājums ietver REST API redaktoru — vizuālu saskarni, kas ļauj vaicāt API galapunktus. Tas pieņem pielāgotas galvenes, vaicājuma parametrus un dažus citus parametrus.

Lai instalētu REST klients, atveriet VS Code un noklikšķiniet uz Paplašinājumi cilne. Meklēt REST klients un noklikšķiniet uz Uzstādīt pogu, lai to pievienotu VS kodam.

Saskaņā Sīkāka informācija cilnē atradīsit noderīgu pamācību par to, kā izmantot klientu API pieprasījumu veikšanai. Apskatīsim četrus izplatītākos pieprasījumu veidus un to veikšanu, izmantojot paplašinājumu REST Client.

Mēs izmantosim JSONPlaceholder lai demonstrētu API zvanu veikšanu, izmantojot paplašinājumu REST Client. Tas nodrošina sešus izplatītus resursus, kurus varat lasīt, rediģēt, atjaunināt vai dzēst, veicot API pieprasījumus.

GET pieprasījuma veikšana, izmantojot REST klienta paplašinājumu

Sāciet, izveidojot a .http failu jūsu API pieprasījumiem. Jūs varat nosaukt failu myrequests.http.

Pievienojiet tālāk norādīto kodu savam myrequests.http failu, lai izgūtu resursu no JSONPlaceholder API, kura ID ir 1:

GŪT https://jsonplaceholder.typicode.com/posts/1 HTTP/1.1

Lai nosūtītu pieprasījumu, noklikšķiniet uz Nosūtīt pieprasījumu poga, kas parādās faila augšdaļā. Tiks atvērts jauns logs, kurā būs informācija par atbildi.

Tādā veidā jūs veicat GET pieprasījumu VS kodā.

POST pieprasījuma veikšana, izmantojot REST klienta paplašinājumu

Jūs veicat POST pieprasījumu, kad vēlaties ievietot datus serverī, parasti, lai izveidotu jaunu resursu.

Lai izveidotu jaunu resursu JSONPlaceholder API, nomainiet kodu savā myrequests.http failu ar šādu:

POSTĪT https://jsonplaceholder.typicode.com/posts HTTP/1.1
Satura veids: "application/json"
{
 "title": "foo",
 "body": "bārs",
 "lietotāja ID": 1
}

Noklikšķiniet uz Nosūtīt pieprasījumu pogu, lai nosūtītu pieprasījumu. Atkal tiks atvērts jauns logs ar atbildes datiem. Atbilde parāda an HTTP/1.1 201 Izveidots ziņojumu un ziņas ID kopā ar citiem datiem, ja API izsaukums ir veiksmīgs.

{
 "id": "101"
}

PUT pieprasījuma veikšana, izmantojot REST klienta paplašinājumu

Jūs veicat PUT pieprasījumu, kad vēlaties atjaunināt datus serverī.

Lai atjauninātu esošu resursu JSONPlaceholder API, nomainiet kodu savā myrequests.http failu ar šādu:

PUT https://jsonplaceholder.typicode.com/posts/1 HTTP/1.1
Satura veids: "application/json"
{
 "title": "jauns foo",
 "body": "jauna josla",
 "lietotāja ID": 1
}

Pēc pieprasījuma nosūtīšanas resurss tiks atjaunināts viltotajā serverī, un jūs saņemsit HTTP/1.1 200 OK ziņa.

PATCH pieprasījuma veikšana, izmantojot REST klienta paplašinājumu

Jūs veicat PATCH pieprasījumu, ja vēlaties modificēt noteiktu servera resursa lauku vai rekvizītu.

Lai fiktīvajā serverī atjauninātu tikai esoša resursa nosaukumu, nomainiet kodu savā myrequests.http failu ar šādu:

https://jsonplaceholder.typicode.com/posts/1 HTTP/1.1 
Satura veids: "application/json"
{
 "title": "cits foo"
}

Pēc pieprasījuma iesniegšanas resursa nosaukums tiks atjaunināts viltotajā serverī, un jūs saņemsit HTTP/1.1 200 OK ziņojumu kopā ar citiem resursa datiem.

DZĒŠANAS pieprasījuma veikšana, izmantojot REST klienta paplašinājumu

Jūs veicat DELETE pieprasījumu, kad vēlaties dzēst resursu serverī.

Lai dzēstu esošu resursu viltotajā serverī, nomainiet kodu savā myrequests.http failu ar šādu:

DZĒST https://jsonplaceholder.typicode.com/posts/1 HTTP/1.1

Lūk, Satura veids nav nepieciešama, un tas nav arī datu objekts. Ja nosūtāt pieprasījumu un veiksmīgi izdzēsāt resursu, jums vajadzētu saņemt HTTP/1.1 200 OK atbilde ar tukšu objektu.

Veiciet API zvanus tieši no VS koda iekšpuses

Iepriekš jūs, iespējams, izmantojāt trešo pušu rīkus, piemēram Pastnieks, lai veiktu API pieprasījumus. Lai gan šie rīki labi veic darbu, to iestatīšana prasa laiku. Piemēram, lai izmantotu API Explorer, jums ir jābūt kontam pakalpojumā Postman.

Lai gan tādas ir vairāki tiešsaistes API testēšanas rīki, taču ar tādiem paplašinājumiem kā REST Client API testēšana ir daudz ātrāka un vienkāršāka. Jūs varat pārbaudīt jebkuru API tieši no VS koda redaktora. Tas ir īpaši noderīgi, ja izstrādājat API lokāli un vēlaties lidojuma laikā pārbaudīt vietējās API.

Citi API testēšanas VS koda paplašinājumi

Rest Client ir viegli lietojams. Taču tas nav vienīgais VS koda paplašinājums API testēšanai. Citas populāras iespējas ir Thunder Client, httpYak un httpBook.

Thunder Client nodrošina vizuālu API redaktoru, lai vienkāršotu API pieprasījumus. Protams, jums ir jāzina, kas ir REST API, lai izmantotu šos rīkus.