API-kõne tegemine VS Code'is on imelihtne, installige lihtsalt üks laiendus ja siis ei pea te töö tegemiseks lootma välistele tööriistadele.

Arendamise ajal esitate API-dele taotlusi sageli. See võib olla seotud mõne välise API või teie enda taustaserveri API-ga.

API-kõnede tegemiseks saate kasutada kolmanda osapoole tööriistu, nagu Postman. Kuid VS-koodi laiendus võimaldab teil teha API-kõnesid otse VS-koodist. Siit saate teada, kuidas VS-koodis API taotlusi täita.

VS Code REST kliendilaiendus

VS Code'i laiendus on pistikprogramm või lisandmoodul, mis täiustab Visual Studio Code redaktori funktsioone. VS Code'i laienduste turg pakub mitut tüüpi laiendusi, mis aitavad teil programmeerimisülesandeid täita. Keeletoe lisamiseks on laiendus. Üks on automaatse täitmise pakkumiseks konkreetse programmeerimiskeele jaoks ja nii edasi. Laiendused muudavad VS-koodiga programmeerimise lihtsamaks.

Laiendus REST Client võimaldab teil täita API päringuid VS-koodi sees. Laiendus sisaldab REST API redaktorit, visuaalset liidest, mis võimaldab teil teha päringuid API lõpp-punktide kohta. See aktsepteerib kohandatud päiseid, päringu parameetreid ja mõningaid muid parameetreid.

instagram viewer

Et installida REST klient, avage VS Code ja klõpsake nuppu Laiendused sakk. Otsima REST klient ja klõpsake nuppu Installige nuppu, et see VS-koodi lisada.

all Üksikasjad vahekaardilt leiate kasuliku õpetuse selle kohta, kuidas klienti API taotluste tegemiseks kasutada. Vaatame nelja levinumat päringutüüpi ja nende esitamist laienduse REST Client abil.

Me hakkame kasutama JSONPlaceholder API-kõnede tegemise demonstreerimiseks REST-kliendilaiendi abil. See pakub kuut levinud ressurssi, mida saate API taotlusi esitades lugeda, redigeerida, värskendada või kustutada.

GET-i päringu esitamine kliendilaienduse REST abil

Alustage a .http fail teie API taotluste jaoks. Saate failile nime anda myrequests.http.

Lisage omale järgmine kood myrequests.http fail ressursi toomiseks JSONPlaceholder API-st, mille ID on 1:

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

Taotluse saatmiseks klõpsake nuppu Saada taotlus nuppu, mis kuvatakse faili ülaosas. Avaneb uus aken, mis sisaldab vastuse üksikasju.

Nii saate teha VS-koodis GET-päringu.

POST-päringu tegemine REST-kliendilaiendi abil

POST-päringu esitate, kui soovite andmeid serverisse postitada, tavaliselt uue ressursi loomiseks.

JSONPlaceholder API-s uue ressursi loomiseks asendage oma kood myrequests.http faili järgmisega:

POSTITA https://jsonplaceholder.typicode.com/posts HTTP/1.1
Sisu tüüp: "rakendus/json"
{
 "title": "foo",
 "keha": "baar",
 "kasutaja ID": 1
}

Klõpsake nuppu Saada taotlus nuppu päringu saatmiseks. Jällegi avaneb see uus aken, mis sisaldab vastuse andmeid. Vastus näitab an HTTP/1.1 201 Loodud sõnumi ja postituse ID koos muude andmetega, kui API-kõne õnnestub.

{
 "id": "101"
}

PUT-päringu tegemine REST-kliendilaiendi abil

Kui soovite serveris andmeid värskendada, esitate PUT-päringu.

Olemasoleva ressursi värskendamiseks JSONPlaceholder API-s asendage kood oma myrequests.http faili järgmisega:

PANGE https://jsonplaceholder.typicode.com/posts/1 HTTP/1.1
Sisu tüüp: "rakendus/json"
{
 "title": "uus foo",
 "body": "uus riba",
 "kasutaja ID": 1
}

Pärast päringu saatmist värskendatakse ressurssi näidisserveris ja saate selle HTTP/1.1 200 OK sõnum.

PATCH-i taotluse esitamine kliendilaiendi REST abil

PATCH-päringu esitate, kui soovite muuta serveris antud ressursi konkreetset välja või atribuuti.

Ainult olemasoleva ressursi pealkirja värskendamiseks näidisserveris asendage kood oma myrequests.http faili järgmisega:

https://jsonplaceholder.typicode.com/posts/1 HTTP/1.1 
Sisu tüüp: "rakendus/json"
{
 "title": "teine ​​foo"
}

Pärast päringu esitamist värskendatakse näidisserveris ressursi pealkirja ja saate selle HTTP/1.1 200 OK teade koos ressursi muude andmetega.

Kustutamistaotluse esitamine kliendilaiendi REST abil

Kui soovite serverist ressurssi kustutada, esitate DELETE päringu.

Olemasoleva ressursi kustutamiseks näidisserveris asendage kood oma myrequests.http faili järgmisega:

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

Siin, Sisu tüüp pole nõutav ega ka andmeobjekt. Kui saadate päringu ja kustutate ressursi edukalt, peaksite saama HTTP/1.1 200 OK vastuseks tühja objektiga.

Tehke API-kõnesid otse VS-koodi seest

Varem olete võib-olla kasutanud kolmanda osapoole tööriistu, nagu Postimees API päringuid tegema. Kuigi need tööriistad teevad oma tööd hästi, võtab nende seadistamine aega. Näiteks API exploreri kasutamiseks peab teil olema Postmani konto.

Kuigi neid on mitu veebipõhist API testimise tööriista, kuid selliste laiendustega nagu REST Client on API-de testimine palju kiirem ja lihtsam. Saate testida mis tahes API-d otse oma VS-koodi redaktoris. See on eriti kasulik, kui arendate API-sid kohapeal ja soovite oma kohalikke API-sid käigupealt testida.

Muud API testimise VS-koodi laiendused

Rest Clienti on lihtne kasutada. Kuid see pole ainus VS-koodi laiendus API-de testimiseks. Teised populaarsed valikud on Thunder Client, httpYak ja httpBook.

Thunder Client pakub API-taotluste lihtsustamiseks visuaalset API-redaktorit. Loomulikult peate nende tööriistade kasutamiseks teadma, mis on REST API.