REST API -asiakas / -testaaja

Kokoa ja lähetä HTTP-pyyntöjä kyselyparametreilla, otsikoilla, JSON- tai lomakerungoilla sekä Basic- tai Bearer-todennuksella ja tarkista tila, ajoitus ja kauniiksi muotoillut JSON-vastaukset. Tuo olemassa oleva cURL-komento tai kopioi nykyinen pyyntö takaisin cURL-muodossa. Uudelleenkäytettävien pyyntöjen rakentaminen vaihe vaiheelta onnistuu HTTP-pyyntörakentajalla. Katso myös API-työkalut -perhe.
Kaikki toimii paikallisesti selaimessa. Eri alkuperän pyynnöt noudattavat kohteen palvelimen CORS-käytäntöä — katso alla oleva huomautus, jos pyyntö epäonnistuu.
Liitä cURL-komento
Kyselyparametrit
Otsakkeet
Runko
Authorization
Asetukset
Kun tämä on täytetty, pyynnön URL liitetään tähän etuliitteeseen. Hyödyllinen CORS-estetyille palvelimille.
200
Runko Otsikot

                                                                

                                                                

                                                                    

                                                                

                                                            


                                                            

                                                            
Miksi pyyntö voi epäonnistua: selaimet estävät eri alkuperän lukemisen, ellei API palauta Access-Control-Allow-Origin-otsikkoa. Jos kohde ei salli CORS:ia, voidaan ajaa oma CORS-välityspalvelin ja liittää sen URL-osoite yllä olevaan etuliitekenttään, tai käyttää cURL-muunninta pyynnön ajamiseen terminaalista. GET- ja HEAD-pyyntöjen runko ohitetaan, ja WebSocket-työkalu on erikseen osoitteessa WebSocket-testaaja.


                                                            

                                                                HTTP-metodien selitys
                                                                
Valitsemasi metodi kertoo palvelimelle, mitä URL-osoitteelle halutaan tehdä. Tässä on, mitä kukin seitsemästä verbistä, joita tämä työkalu voi lähettää, tarkoittaa:

                                                                
GET — Hae resurssi: verkkosivu, kuva, tietueiden luettelo. “Palauta tässä URL-osoitteessa oleva sisältö.” Vain luku ja turvallinen toistaa, eikä siinä normaalisti ole pyynnön runkoa (GET-pyynnön runko, jos sellainen on, ohitetaan).

                                                                
POST — Lähetä uutta dataa palvelimelle, yleensä resurssin luomiseksi tai toiminnon käynnistämiseksi — lomakkeen lähetys, tiedoston lataus, työn käynnistys. Hyötykuorma kulkee pyynnön rungossa. POST ei ole idempotentti: saman POST-pyynnön lähettäminen kahdesti voi luoda kaksi tietuetta.

                                                                
PUT — Korvaa koko resurssi URL-osoitteessa lähetetyllä. Rungon on sisällettävä resurssin täydellinen uusi versio. PUT on idempotentti: saman pyynnön toistaminen vaikuttaa samalla tavalla kuin sen lähettäminen kerran.

                                                                
PATCH — Muuta vain osaa resurssista. Lähetetään vain päivitettävät kentät, esim. {"email": "new@example.com"}, koko tietueen sijaan. PATCH valitaan, kun koko PUT pakottaisi lähettämään uudelleen kentät, joihin ei koskettu.

                                                                
DELETE — Poista resurssi URL-osoitteesta. DELETE on idempotentti: jo poistetun asian poistaminen palauttaa saman tuloksen (yleensä 404) eikä tee mitään kahdesti.

                                                                
HEAD — Aivan kuten GET, mutta vastaus sisältää vain otsikot — runkoa ei lähetetä takaisin lainkaan. HEAD-pyyntöä käytetään tarkistamaan, onko URL olemassa, kuinka suuri tiedosto on (Content-Length), milloin se on viimeksi muokattu (Last-Modified) tai mikä sen tyyppi on (Content-Type), lataamatta koko sisältöä.

                                                                
OPTIONS — Kysy palvelimelta, mitkä metodit ja asetukset ovat sallittuja URL-osoitteelle, tai käynnistä CORS-esitarkistus. Vastausotsikot, kuten Access-Control-Allow-Methods, luettelevat sallitut. OPTIONS ei yleensä sisällä runkoa; selaimet lähettävät sen usein automaattisesti ennen eri alkuperän POST/PUT/PATCH/DELETE-pyyntöä.

                                                                
Helppo sekoittaa: HEAD vs GET — pyyntö on identtinen, mutta HEAD ei palauta runkoa. PUT vs PATCH — PUT korvaa koko resurssin; PATCH tekee osittaisen päivityksen vain lähetetyille kentille.