Vastuskoodid: 401, 404, 405 ja tühi nimekiri
Saad teada, kuidas server annab vastuskoodidega päringu tulemusest teada. Vaatame, mida tähendavad 401 sisselogimata kasutaja puhul, 405 lubamatu meetodi korral ja 404 olematu toote kustutamisel. Lisaks uurid, miks võib edukas päring tagastada 200 OK ka siis, kui tulemuseks on tühi nimekiri.
Tootest
Tere! Oleme vaadanud, kuidas kõik töötab, kui läheb hästi. Testija kontrollib aga ka seda, kuidas server probleemidest teatab: selleks on igal vastusel olekukood. Täna vaatame levinumaid koode BB Foodi admin-paneeli näidete põhjal.
Suurepärane! Millest alustame?
Kadri ootab sind juba nõupidamisruumis ja näitab kõik ette. Täna on neli juhtumit: 401, 405, tühi nimekiri koodiga 200 ja toote kustutamine, mida enam pole.
Tere! Igal serveri vastusel on olekukood. Sa oled juba näinud koode 200, 201 ja 204. Koodi esimene number annab aimu, mis juhtus.
Tere, Kadri! Mida esimene number tähendab?
Koodid jagunevad esimese numbri järgi gruppidesse. Jäta meelde neli peamist:
Olekukoodid
2xx— edu: päring täideti (200 OK,201 Created,204 No Content)3xx— ümbersuunamine: ressurss on kolinud. Näiteks vana pakkumiste leht/salekustutati ja pakkumised on nüüd aadressil/promo. PäringuleGET /salevastab server301 Moved Permanently, kirjutab päisesseLocationaadressi/promoja brauser läheb sinna ise4xx— kliendi viga: päring on vale või seda ei saa täita (401,404,405)5xx— serveri viga: klient tegi kõik õigesti, aga serveris läks midagi katki (500,503)
Kontrollime, kas on selge. Server vastas koodiga 404. Kelle viga see on?
Vaatame näidete varal!
Testitav rakendus
Näide 1
Esimene näide. Administraator avas admin-paneeli, kuid pole sisse logitud. Ta üritab siiski toodet lisada.
Ja mida server vastab?
Klient saadab toote lisamise päringu, kuid selles pole kinnitust, et selle saatis sisse logitud administraator. Vajuta „Lisa toode“ ja vaata, mis juhtub.
Päring
POST /api/v1/products
{
"name": "Kodujuust, 200 g",
"price": 1.89
}- meetod ja aadress on samad mis eduka lisamise korral:
POST /api/v1/products - päringu keha (request body) on uue toote andmed ja need on õiged
- sisselogimise kinnitust pole: server ei tea, kes päringu saatis
Animatsioon on aeglustatud: tegelikult võtab kogu teekond mõnikümmend millisekundit.
| id | name | price |
|---|
Tooteid pole veel laaditud.
Server vastas koodiga 401 Unauthorized — „autoriseerimata“. Ta ei tea, kes päringu saatis, seepärast keeldus ta juba enne andmebaasi poole pöördumist. Andmebaas selles stsenaariumis ei osalenud ja tabel jäi samaks.
Vastus
401 Unauthorized
{
"error": "Unauthorized"
}- olekukood — kuidas läks.
401 Unauthorizedtähendab „logi sisse“ - vastuse keha (response body) — veateade, mitte toode
Mida testija kontrollib: kood on 401, toodet andmebaasi ei lisatud ja kasutaja näeb arusaadavat teadet ning saab uuesti sisse logida.
Mida tähendab kood 401?
Selge! Aga mis kood järgmisena tuleb?
Näide 2
Teine näide. Kliendi arendaja lisas halduspaneelile nupu „Kustuta kõik tooted“, kuid eksis: see saadab DELETE-i kogu nimekirja aadressile, aga server sellist tegevust ei toeta.
Kas see õnnestub?
Nupp saadab DELETE-i aadressile /api/v1/products, see tähendab kogu nimekirjale, mitte ühele tootele. Klient eksis, kuid server ei usalda klienti ja kontrollib iga päringut ise. Vajuta „Kustuta kõik tooted“ ja vaata, mida server vastab.
Päring
DELETE /api/v1/products
- meetod — mida teha.
DELETEtähendab „kustuta“ - aadress —
/api/v1/products: kogu nimekiri, toote numbrit pole - keha pole
Server vastas koodiga 405 Method Not Allowed — „meetod pole lubatud“. Aadress on olemas, kuid selle jaoks toetab server ainult GET ja POST. Andmebaas ei osalenud ja kõik tooted on alles.
Vastus
405 Method Not Allowed
{
"error": "Method Not Allowed"
}- olekukood —
405 Method Not Allowedtähendab „see meetod pole selle aadressi jaoks lubatud“ - vastuse keha (response body) — veateade
Mida testija kontrollib: kood on 405, andmebaasi andmed ei muutunud ja kasutaja näeb arusaadavat teadet. Lisaks registreerib ta kliendi kohta vea: nupp saadab päringu, mida server ei toeta. Ära aja segi koodiga 404: seal ei leita aadressi või ressurssi ennast.
Server lubab aadressile /api/v1/products ainult GET-i ja POST-i. Klient saatis DELETE-i. Millise koodi server tagastab?
Aga kui kõik õnnestus, kuid andmeid pole?
Näide 3
Kolmas näide on kavalam. Pood just avati ja andmebaasis pole veel ühtegi toodet. Ostja avab kataloogi.
Kas server tagastab vea?
Klient küsib tootenimekirja, täpselt nagu esimeses ülesandes. Vaata andmebaasi tabelit: see on tühi. Vajuta „Laadi tooted“ ja vaata, mida server vastab.
Päring
GET /api/v1/products
- meetod ja aadress on samad:
GET /api/v1/products - keha pole
- tabelis
productspole ühtegi rida
Server vastas koodiga 200 OK ja kehas on tühi nimekiri []. See pole viga: päring täideti edukalt, sobivaid andmeid lihtsalt pole. Server leidis andmebaasist 0 rida ja tagastas ausalt tühja nimekirja.
Vastus
200 OK []
- olekukood —
200 OKtähendab „päring õnnestus“ - vastuse keha (response body) — tühi nimekiri
[]: tooteid pole, kuid viga ka pole
Mida testija kontrollib: kood on 200, mitte 404 või 500, kehas on tühi nimekiri [] ja saidil on arusaadav vihje nagu „Tooteid veel pole“, mitte tühi ekraan või viga.
Server tagastas 200 OK ja tühja nimekirja []. Kas see on viga?
Aga mis juhtub, kui kustutada toode, mida enam pole?
Näide 4
Ja viimane näide. Kaks administraatorit töötavad korraga. Üks on toote „Piim 2,5%, 1 l“ juba kustutanud ja teisel pole leht uuenenud, nii et toode on nimekirjas alles.
Ja mis juhtub, kui see uuesti kustutada?
Pane tähele: andmebaasi tabelis toodet id-ga 3 enam pole, kuid kliendi nimekirjas on see alles. Vajuta „Kustuta „Piim 2,5%, 1 l““ ja vaata, mida server vastab.
Päring
DELETE /api/v1/products/3
- meetod ja aadress on nagu tavalisel kustutamisel:
DELETE /api/v1/products/3 - keha pole
- toodet
id-ga 3 pole andmebaasis enam
Server vastas koodiga 404 Not Found — „ei leitud“. Andmebaas ei leidnud rida id-ga 3, ei kustutanud midagi ja teatas serverile: kustutati 0 rida. Kuna kustutada polnud midagi, vastas server ausalt, et sellist toodet pole. Pane tähele: korduv DELETE andmebaasi ei muutnud — toodet pole nii pärast esimest kui ka teist päringut. Erineb ainult vastuse kood: esimesel korral 204 ja teisel 404. Seega erinevalt POST-ist ei tekita DELETE-i kordamine duplikaate ega riku andmeid.
Vastus
404 Not Found
{
"error": "Product not found"
}- olekukood —
404 Not Foundtähendab „sellist ressurssi pole“ - vastuse keha (response body) — veateade
Mida testija kontrollib: kood on 404 mitte 204, andmebaas ei muutunud ja kasutaja näeb arusaadavat teadet, näiteks „Toodet ei leitud: võib-olla see kustutati juba“.
Mida server tagastab toote kustutamisel, mida enam pole?
Tundub, et sain aru!
Suurepärane! Nüüd oskad vastuskoode lugeda. Jäta meelde: 401 — pole sisse logitud, 405 — meetod pole lubatud, 404 — ei leitud ja 200 tühja nimekirjaga — pole viga. Testija kontrollib nii koodi, andmebaasi andmeid kui ka teadet, mida kasutaja näeb.
Lühiviide
Koodigrupid
Koodi esimene number annab aimu, mis juhtus. 2xx on edu, 4xx on kliendi viga (vale või täitmatu päring), 5xx on serveri viga.
401 Unauthorized
Server ei tea, kes päringu saatis: klient pole sisse logitud või saatis kehtetud sisselogimisandmed. Testija kontrollib, et andmed ei muutunud ja kasutaja näeb arusaadavat teadet.
405 Method Not Allowed
Aadress on olemas, kuid see meetod pole selle jaoks lubatud.
404 Not Found
Sellist ressurssi pole: näiteks toode on juba kustutatud. Server ei muuda midagi ja teatab, et otsitavat pole.
200 OK ja tühi nimekiri
Tühi tulemus pole viga. Päring õnnestus, sobivaid andmeid lihtsalt pole. Testija kontrollib koodi 200, tühja nimekirja kehas ja arusaadavat vihjet kasutajale.