PUT-meetod: toote asendamine
Saad teada, kuidas administraator asendab olemasoleva toote täielikult. Vaatame, kuidas PUT-päringuga saadetakse kõik toote andmed, mida tähendab edukat uuendamist näitav olekukood 200 ning mille poolest PUT-meetod PATCH-meetodist erineb.
Tootest
Tere! Hinna muutmine on selge. Aga mis siis, kui on vaja uuendada terve toode: nii nimi kui ka hind? Täna vaatame teist muutmisviisi — PUT-meetodit — ja võrdleme seda PATCH-iga.
Selge! Aga kuidas see töötab?
Kõik seletab Kadri: Kadri ootab sind juba nõupidamisruumis. Võtame ainult positiivse stsenaariumi: kõik läheb nii, nagu peab.
Tere! PATCH-iga oled sa juba tuttav: see muudab osa andmetest. Toote täielikuks asendamiseks on HTTP-s PUT-meetod.
Tere, Kadri! Mille poolest PUT PATCH-ist erineb?
PUT tähendab „asenda täielikult“. Klient paneb aadressi sisse toote ja saadab kehas kõik selle andmed: nii nime kui ka hinna. Server asendab toote nendega täielikult. Siin on näide tootele id 5:
Päring
PUT /api/v1/products/5
{
"name": "Rukkileib, 400 g",
"price": 1.99
}- meetod — mida teha.
PUTtähendab „asenda täielikult“ - aadress — millega.
/api/v1/products/5on toodeid-ga 5 - päringu keha (request body) — toote täielikud andmed: nimi ja hind. Isegi kui muutus ainult üks väli, saadetakse kõik
Ja mida server PUT-ile vastab?
Server asendab toote andmed andmebaasis ja vastab koodiga 200 OK. Vastuse kehas tagastab ta terve toote. id jääb samaks: PUT muudab sisu, mitte toote numbrit.
Vastus
200 OK
{
"id": 5,
"name": "Rukkileib, 400 g",
"price": 1.99
}- olekukood — kuidas läks.
200 OKtähendab „õnnestus“ - vastuse keha (response body) — terve toode:
id, nimi ja hind
Märkus: 200 on levinud, kuid mitte ainus variant. Olenevalt teostusest võib server vastata näiteks 204 No Content ilma kehata või 201 Created, kui selle id-ga toodet veel polnud ja PUT lõi selle.
Kontrollime, kas on selge. Mis on PUT-i ja PATCH-i peamine erinevus?
Vaatame seda praktikas!
Siin on BB Foodi admin-paneel. Vali toode, muuda nime ja hinda ning vajuta „Salvesta toode“. Pane tähele: vormis on mõlemad väljad, sest PUT saadab terve toote.
Testitav rakendus
Stsenaarium. Positiivne: administraator asendab toote andmed
Server ootab päringuid. Vajuta „Salvesta toode“, et klient saadaks PUT-päringu.
Animatsioon on aeglustatud: tegelikult võtab kogu teekond mõnikümmend millisekundit.
| id | name | price |
|---|
Sisesta nimi ja hind — number, mis on suurem kui null.
Kataloogis ei ole enam tooteid.
Valmis! Server tagastas 200 OK ja terve toote. Tabelis uuenes kogu rida: nii nimi kui ka hind, id jäi samaks.
Administraator muutis vormis ainult hinda, kuid vajutas „Salvesta toode“. Mida klient PUT-i kehas saadab?
Aga mida ma siin kontrollima peaksin?
Kontrolli kolme asja. Esiteks: vastuse kood on 200 OK ja kehas on terve toode uute andmetega. Teiseks: andmebaasi tabelis uuenesid nimi ja hind, id ei muutunud. Kolmandaks: eraldi päring GET /api/v1/products tagastab toote juba uue nime ja hinnaga, seega näevad neid ka ostjad.
Lühiviide
PUT-meetod
PUT /api/v1/products/5 tähendab „asenda täielikult“. Päringu kehas saadetakse objekti kõik andmed ja server asendab nendega varasemad.
Kood 200 OK
Edukas vastus. Server tagastab kehas terve toote, juba uute andmetega. Asendamisel ei muutu id ise.
PUT ja PATCH
PUT saadab kõik väljad, isegi kui muutus ainult üks. PATCH saadab ainult muudetavad väljad.
Mida testija kontrollib
Vastuse kood on 200 ja kehas on toode uute andmetega. Andmebaasis uuenesid nimi ja hind, id on sama. Uued andmed on näha admin-paneelis ja kataloogis.