Kokoa HTTP-pyyntö vaihe vaiheelta — polkumuuttujat, kuten
{userId}, kyselyparametrit,
otsikot, JSON- ja lomakerungot sekä todennus — ja luo valmiita koodeja
cURL-,
Node.js fetch-,
Python requests- tai
PowerShell-muotoon.
Tämä työkalu on
suunnittelua ja koodin luontia varten; pyynnön lähettämiseksi ja elävän vastauksen tarkastelemiseksi siirrä
pyyntö painikkeella
Testipyyntö → (avautuu
REST API Client / Tester), tai muunna liitetty cURL
cURL Command Converter -työkalulla.
Kaikki kootaan paikallisesti selaimessa. Tältä sivulta ei lähetetä koskaan pyyntöjä.
Vinkit: kääri URL-osa aaltosulkeisiin (
{userId}) käsitelläkseen sitä polkuparametrina; luotu koodi päivittyy jokaisen muokkauksen yhteydessä.
GET- ja HEAD-pyynnöt jättävät rungon huomiotta. Luodut tiedostolataukset käyttävät cURL:ssa
@file-tyyliä tai paikanvaraajia muissa kielissä — liitä oikeat tiedostot omaan koodiisi.
Eri alkuperän lähetykset kuuluvat
REST API Client -työkalulle (noudata palvelimen CORS-käytäntöä); olemassa olevan komennon käänteiseen muunnokseen käytä
cURL Command Converter -työkalua.
HTTP-metodien selitys
Kun valitset metodin, luotu cURL / Node / Python / PowerShell -koodi muuttuu vastaamaan sitä. Tässä on, mitä kukin verbi tarkoittaa rakentamallesi pyynnölle:
GET — Hakee resurssin esityksen. Sen ei pitäisi muuttaa palvelimen tilaa, ja luotu pyyntö on yleensä ilman runkoa. Käytä GET-metodia lukemiseen, hakuihin ja listaendpointeihin.
POST — Lähettää tietoja uuden resurssin luomiseksi tai toiminnon käynnistämiseksi. Runko tulee luotuun koodiin hyötykuormaksi (cURL:ssa --data-raw, Node/Python-koodissa runkoargumenttina jne.). POST ei ole idempotentti: kahdesti lähetettynä se voi luoda kaksi resurssia.
PUT — Korvaa olemassa olevan resurssin kokonaan. Lähetä koko objekti rungossa; puuttuvat kentät voidaan käsitellä tyhjinä. Luotu koodi lähettää koko rungon tarkalleen tähän URL-osoitteeseen.
PATCH — Päivittää vain sisällytetyt kentät. Runko kuljettaa osittaisen muutossarjan, joten luodut pyynnöt ovat pienempiä kuin PUT, kun muokataan vain yhtä tai kahta arvoa.
DELETE — Poistaa resurssin URL-osoitteesta. Se on idempotentti ja yleensä ilman runkoa, joten luotu koodi on yksinkertainen poistokutsu pelkillä otsikoilla.
HEAD — Pyytää vain otsikoita ilman vastausrunkoa. Luotu koodi näyttää GET-pyynnöltä, mutta palauttaa metatietoja, kuten Content-Length, Last-Modified tai Content-Type, mikä säästää kaistaa.
OPTIONS — Selvittää, mitä palvelin sallii URL-osoitteelle, tai simuloi CORS-esilennon. Vastausotsikot (esimerkiksi Access-Control-Allow-Methods) näyttävät sallitut verbit. OPTIONS-pyynnöllä ei yleensä ole runkoa.
Helppo sekoittaa: HEAD vs GET — luodut pyynnöt ovat samankaltaisia, mutta HEAD ei palauta runkoa. PUT vs PATCH — PUT kirjoittaa koko resurssin uudelleen; PATCH muuttaa vain annettuja kenttiä.
