Vigade haldus

Võimalusel proovivad veateated selgitada, mis valesti läks. Kõige sagedamini on puudu mõni kohustuslik väli.

Veateate vorming

Kõik veateated järgivad ühtset JSON struktuuri:

{
    "error": {
        "code": "error_type",
        "details": {
            "field_name": [
                "error message"
            ]
        },
        "message": "Inimloetav sõnum",
        "status": 422
    }
}

Levinud vigade näited

Puuduv kohustuslik väli

Staatus: 422

{
    "error": {
        "code": "unprocessable_entity",
        "details": {
            "title": [
                "can't be blank"
            ]
        },
        "message": "Midagi läks valesti",
        "status": 422
    }
}

Mitu puuduvat välja

Staatus: 422

{
    "error": {
        "code": "unprocessable_entity",
        "details": {
            "owner": [
                "must exist"
            ],
            "manager": [
                "must exist"
            ]
        },
        "message": "Midagi läks valesti",
        "status": 422
    }
}

HTTP staatuskoodid

Kood	Tähendus	Kirjeldus
200	OK	Päring õnnestus
401	Autoriseerimata	Vigane või puuduv autentimise võti
403	Keelatud	Kehtiv võti, kuid ebapiisavad õigused
404	Ei leitud	Ressurssi ei leitud
422	Töödeldamatu sisu	Valideerimisvead päringu andmetes
500	Serveri viga	Midagi läks meie poolt valesti