PATCH-meetod: hinna muutmine
Saad teada, kuidas administraator muudab olemasoleva toote andmeid. Vaatame, kuidas PATCH-päringuga muudetakse ainult toote hinda, mida tähendab edukat uuendamist näitav olekukood 200 ning kuidas muudatus andmebaasi salvestatakse.
Tootest
Tere! Oleme õppinud tooteid lisama. Kuid sagedamini on kataloogis vaja lihtsalt midagi parandada: näiteks hinda muuta. Täna vaatame, kuidas administraator toote hinda muudab.
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! Olemasoleva toote muutmiseks on HTTP-s meetodid PATCH ja PUT. Alustame PATCH-ist: see muudab ainult osa andmetest.
Tere, Kadri! Kuidas näeb PATCH-päring välja?
PATCH tähendab „muuda osaliselt“. Klient paneb aadressi sisse, millist toodet muuta, ja saadab kehas ainult selle, mida on vaja muuta. Näiteks toote id 3 uue hinna:
Päring
PATCH /api/v1/products/3
{
"price": 1.29
}- meetod — mida teha.
PATCHtähendab „muuda osa andmeid“ - aadress — millega.
/api/v1/products/3on toodeid-ga 3 - päringu keha (request body) — ainult muudetav väli. Nime pole vaja saata: see jääb samaks
Ja mida server PATCH-ile vastab?
Server uuendab andmebaasis ainult saadetud välja ja vastab koodiga 200 OK. Vastuse kehas tagastab server terve toote, juba uue hinnaga, et klient saaks kohe näidata värsket infot.
Vastus
200 OK
{
"id": 3,
"name": "Piim 2,5%, 1 l",
"price": 1.29
}- olekukood — kuidas läks.
200 OKtähendab „õnnestus“ - vastuse keha (response body) — terve toode:
id, nimi ja uus hind
Märkus: 200 on levinud, kuid mitte ainus variant. Olenevalt teostusest võib server vastata näiteks 204 No Content ilma kehata.
Kontrollime, kas on selge. Administraator tahab muuta ainult toote hinda, nime ei ole vaja puutuda. Mida klient PATCH-päringu kehas saadab?
Vaatame seda praktikas!
Siin on BB Foodi admin-paneel. Vali toode, sisesta uus hind ja vajuta „Muuda hinda“. Jälgi päringu teed: klient → server → andmebaas → server → klient.
Testitav rakendus
Stsenaarium. Positiivne: administraator muudab toote hinda
Server ootab päringuid. Vajuta „Muuda hinda“, et klient saadaks PATCH-päringu.
Animatsioon on aeglustatud: tegelikult võtab kogu teekond mõnikümmend millisekundit.
| id | name | price |
|---|
Sisesta hind — number, mis on suurem kui null.
Kataloogis ei ole enam tooteid.
Valmis! Server tagastas 200 OK ja terve toote. Vaata tabelit: real muutus ainult hind, nimi jäi samaks. Nii PATCH töötab: muutub see, mis saadeti.
Mis juhtub toote nimega pärast PATCH-päringut, mille kehas on ainult hind?
Aga mida ma siin kontrollima peaksin?
Kontrolli kolme asja. Esiteks: vastuse kood on 200 OK ja kehas on toode uue hinnaga. Teiseks: andmebaasi tabelis muutus hind, nimi ja id jäid samaks. Kolmandaks: eraldi päring GET /api/v1/products tagastab toote juba uue hinnaga, seega näevad seda ka ostjad.
Lühiviide
PATCH-meetod
PATCH /api/v1/products/3 tähendab „muuda osaliselt“. Päringu kehas saadetakse ainult need väljad, mida on vaja muuta, teised jäävad samaks.
Kood 200 OK
Edukas vastus. PATCH-i puhul tagastab server kehas tavaliselt terve toote, juba muudatustega.
PATCH ja PUT
PATCH muudab osa andmetest, PUT asendab objekti täielikult. Ühe välja parandamiseks on PATCH mugavam.
Mida testija kontrollib
Vastuse kood on 200 ja kehas on toode uue hinnaga. Andmebaasis muutus ainult hind, nimi ja id on samad. Uus hind on näha admin-paneelis ja kataloogis.