კარგი error response ორ რამეს აკეთებს: ის იყენებს სწორ HTTP status code-ს (მანქანით წაკითხვადი სიგნალი) და აბრუნებს თანმიმდევრულ, სტრუქტურირებულ body-ს, რომელზეც დეველოპერს შეუძლია მოქმედება. არათანმიმდევრული error ფორმები client-ის მხარეს ტკივილის ერთ-ერთი უდიდესი წყაროა.
გამოიყენეთ სტანდარტული error ფორმატი: RFC 7807 (problem+json)
RFC 7807 განსაზღვრავს სტანდარტულ „problem details" body-ს გამოყოფილი media type-ით, ასე რომ ყოველი error თქვენს API-ში ერთნაირად გამოიყურება:
HTTP/1.1 404 Not Found
Content-Type: application/problem+json
{
"type": "https://api.example.com/errors/not-found",
"title": "Resource not found",
"status": 404,
"detail": "No user exists with id 999",
"instance": "/users/999"
}
