Az API-hívás kezdeményezése a VS Code-on belül gyerekjáték, csak telepítsen egy bővítményt, és akkor nem kell semmilyen külső eszközre hagyatkoznia a munka elvégzéséhez.
A fejlesztés során gyakori, hogy kéréseket küld az API-knak. Ez lehet valamilyen külső API vagy a saját háttérkiszolgáló API-ja.
Az API-hívások végrehajtásához használhat harmadik féltől származó eszközöket, például a Postmant. A VS Code kiterjesztés azonban lehetővé teszi API-hívások kezdeményezését közvetlenül a VS Code-on belül. Itt megtudhatja, hogyan hajthat végre API-kéréseket a VS Code-ban.
A VS Code REST kliensbővítmény
A VS Code egyik bővítménye olyan beépülő modul vagy kiegészítő, amely továbbfejleszti a Visual Studio Code szerkesztő funkcióit. A VS Code kiterjesztések piacterén többféle kiterjesztés található, amelyek segíthetnek a programozási feladatokban. Van egy bővítmény a nyelvi támogatás hozzáadásához. Van egy az automatikus kiegészítés biztosítására egy adott programozási nyelvhez és így tovább. A kiterjesztések megkönnyítik a VS Code programozást.
A REST Client bővítmény lehetővé teszi az API-kérések végrehajtását a VS Code-on belül. A bővítmény tartalmazza a REST API-szerkesztőt, egy vizuális felületet, amely lehetővé teszi az API-végpontok lekérdezését. Elfogadja az egyéni fejléceket, lekérdezési paramétereket és néhány egyéb paramétert.
A telepítéshez a REST kliens, nyissa meg a VS Code alkalmazást, és kattintson a Kiterjesztések lapon. Keressen rá REST kliens és kattintson a Telepítés gombot, hogy hozzáadja a VS Code-hoz.
Alatt Részletek lapon talál egy hasznos oktatóanyagot arról, hogyan használhatja az ügyfelet API-kérésekhez. Nézzük meg a négy általános kéréstípust, és azt, hogyan lehet ezeket a REST Client kiterjesztés használatával elkészíteni.
Használni fogjuk JSONPlaceholder bemutatni az API-hívások kezdeményezését a REST Client bővítmény használatával. Hat általános forrást biztosít, amelyeket API-kérésekkel olvashat, szerkeszthet, frissíthet vagy törölhet.
GET-kérés készítése a REST Client Extension használatával
Kezdje a létrehozásával a .http fájlt az API-kérelmeihez. Elnevezheti a fájlt kéréseim.http.
Adja hozzá a következő kódot a sajátjához kéréseim.http fájl egy erőforrás lekéréséhez a JSONPlaceholder API-ból, amelynek azonosítója 1:
KAP https://jsonplaceholder.typicode.com/posts/1 HTTP/1.1A kérelem elküldéséhez kattintson a gombra Felkérést küld gombra, amely a fájl tetején jelenik meg. Megnyílik egy új ablak, amely tartalmazza a válasz részleteit.
Így küldhet GET kérést a VS Code-on belül.
POST-kérés készítése a REST Client Extension használatával
POST kérést kell küldenie, amikor adatokat szeretne elküldeni a kiszolgálóra, általában új erőforrás létrehozásához.
Ha új erőforrást szeretne létrehozni a JSONPlaceholder API-ban, cserélje ki a kódot a sajátjában kéréseim.http fájl a következővel:
POST https://jsonplaceholder.typicode.com/posts HTTP/1.1
Tartalom típusa: "alkalmazás/json"
{
"title": "foo",
"test": "bár",
"felhasználói azonosító": 1
}
Kattints a Felkérést küld gombot a kérés elküldéséhez. Ez ismét egy új ablakot nyit meg, amely a válaszadatokat tartalmazza. A válasz egy HTTP/1.1 201 Létrehozva üzenetet és a bejegyzés azonosítóját más adatokkal együtt, ha az API hívás sikeres.
{
"id": "101"
}
PUT-kérés készítése a REST Client Extension használatával
PUT kérést kell küldenie, ha frissíteni szeretné a szerveren lévő adatokat.
Ha frissíteni szeretne egy meglévő erőforrást a JSONPlaceholder API-ban, cserélje ki a kódot kéréseim.http fájl a következővel:
PUT https://jsonplaceholder.typicode.com/posts/1 HTTP/1.1
Tartalom típusa: "alkalmazás/json"
{
"title": "new foo",
"body": "új sáv",
"felhasználói azonosító": 1
}
A kérés elküldése után az erőforrás frissül a próbaszerveren, és kap egy HTTP/1.1 200 OK üzenet.
PATCH-kérés készítése a REST Client Extension használatával
PATCH kérést akkor kell végrehajtania, ha módosítani szeretné egy adott erőforrás adott mezőjét vagy tulajdonságát a kiszolgálón.
Ha csak egy meglévő erőforrás címét szeretné frissíteni az álszerveren, cserélje ki a kódot a szerveren kéréseim.http fájl a következővel:
https://jsonplaceholder.typicode.com/posts/1 HTTP/1.1
Tartalom típusa: "alkalmazás/json"
{
"title": "egy másik foo"
}
Miután elküldte a kérést, az erőforrás címe frissül a hamis szerveren, és kap egy HTTP/1.1 200 OK üzenetet az erőforrás egyéb adataival együtt.
TÖRLÉS KÉRÉS A REST Client Extension használatával
TÖRLÉS kérést kell küldenie, ha törölni szeretne egy erőforrást a kiszolgálón.
Ha törölni szeretne egy meglévő erőforrást az álszerveren, cserélje ki a kódot a szerveren kéréseim.http fájl a következővel:
TÖRÖL https://jsonplaceholder.typicode.com/posts/1 HTTP/1.1
Itt, a Tartalom típus nem szükséges, és az adatobjektum sem. Ha elküldi a kérést és sikeresen törli az erőforrást, akkor kap egy HTTP/1.1 200 OK válasz üres tárggyal.
Indítson API-hívásokat közvetlenül a VS-kód belsejéből
Korábban előfordulhat, hogy harmadik féltől származó eszközöket használt, mint pl Postman API-kéréseket. Bár ezek az eszközök jól végzik a munkát, időbe telik a beállításuk. Például az API Explorer használatához fiókkal kell rendelkeznie a Postmannál.
Bár vannak számos online API tesztelő eszköz, de az olyan bővítményekkel, mint a REST Client, az API-k tesztelése sokkal gyorsabb és egyszerűbb. Bármely API-t tesztelhet közvetlenül a VS-kódszerkesztőben. Ez különösen akkor hasznos, ha helyi API-kat fejleszt, és menet közben szeretné tesztelni a helyi API-kat.
Egyéb API tesztelési VS kódbővítmények
A Rest Client használata egyszerű. De nem ez az egyetlen VS Code kiterjesztés az API-k tesztelésére. További népszerű lehetőségek a Thunder Client, a httpYak és a httpBook.
A Thunder Client vizuális API-szerkesztőt biztosít az API-kérések egyszerűsítésére. Természetesen tudnia kell, hogy mi az a REST API, hogy ezeket az eszközöket használni tudja.
