HTTP-kérés összeállítása lépésenként — útvonalváltozók, például
{userId}, lekérdezési paraméterek,
fejlécek, JSON / űrlap törzsek és hitelesítés — és futásra kész kód generálása
cURL-hoz,
Node.js fetch-hez,
Python requests-hez vagy
PowerShell-hez.
Ez az eszköz
tervezésre és generálásra való; a kérés tényleges elküldéséhez és az élő válasz vizsgálatához a
Tesztkérés → gombbal lehet átadni a kérést (megnyitja a
REST API-kliens / -tesztelő oldalt), vagy a beillesztett cURL a
cURL-parancs-átalakítóval alakítható át.
Minden helyben, a böngészőben készül. Ezen az oldalon soha nem küldünk kérést.
Tippek: egy URL-szegmenst kapcsos zárójelbe (
{userId}) téve útvonalparaméterként kezelhető; a generált kód minden szerkesztésnél frissül.
A GET/HEAD kérések figyelmen kívül hagyják a törzset. A generált fájlfeltöltések a cURL-ben
@file stílusúak, más nyelveken helyőrzők — a valódi fájlokat a saját kódban kell csatolni.
Az eredetek közötti küldést a
REST API-kliens fedi le (tiszteletben tartva a kiszolgáló CORS-szabályzatát); meglévő parancs visszafejtéséhez a
cURL-parancs-átalakító használható.
A HTTP-metódusok magyarázata
Egy metódus kiválasztásakor a generált cURL / Node / Python / PowerShell kód ehhez igazodik. Íme, mit jelent az egyes igék az épülő kérésre nézve:
GET — Az erőforrás egy reprezentációjának lekérése. Nem változtathatja meg a szerver állapotát, a generált kérésnek rendszerint nincs törzse. Olvasásra, keresésre és listavégpontokhoz a GET használandó.
POST — Adatok beküldése új erőforrás létrehozásához vagy egy művelet elindításához. A törzs lesz a generált kód hasznos terhe (cURL-ben --data-raw, Node/Python-ban törzsargumentum stb.). A POST nem idempotens: kétszeri elküldése két erőforrást hozhat létre.
PUT — Egy meglévő erőforrás teljes cseréje. A teljes objektum a törzsben küldendő; a kihagyott mezők üresnek tekinthetők. A generált kód a teljes törzset a pontos URL-re küldi.
PATCH — Csak a megadott mezőket frissíti. A törzs részleges változáskészletet hordoz, így a generált kérések kisebbek a PUT-nál, ha csak egy-két értéket szerkesztünk.
DELETE — Az erőforrás eltávolítása az URL-en. Idempotens, és általában nincs törzse, így a generált kód egyszerű, csak fejlécekkel rendelkező törlési hívás.
HEAD — Csak fejlécek kérése, válaszoltörzs nélkül. A generált kód a GET-hez hasonlít, de olyan metaadatot ad vissza, mint a Content-Length, a Last-Modified vagy a Content-Type, így sávszélességet takarít meg.
OPTIONS — Annak felderítése, mit enged a szerver egy URL-re, vagy egy CORS-előellenőrzés szimulálása. A válaszfejlécek (például Access-Control-Allow-Methods) mutatják az engedélyezett igéket. Az OPTIONS-nak általában nincs kérési törzse.
Könnyen összekeverhető: HEAD vs GET — a generált kérések hasonlók, de a HEAD nem ad vissza törzset. PUT vs PATCH — a PUT az egész erőforrást átírja; a PATCH csak a megadott mezőket változtatja.
