Lỗi

Lỗi dùng các mã trạng thái HTTP thông thường và luôn trả về cùng một cấu trúc JSON, kèm một mã lỗi ổn định mà máy có thể đọc được.

Định dạng lỗi#

{
  "error": {
    "code": "rateLimited",
    "message": "Rate limit exceeded",
    "retryAfter": 12
  }
}

error.code ổn định và có thể dùng an toàn để rẽ nhánh xử lý. error.message là gợi ý dễ đọc cho con người và có thể thay đổi. Một số lỗi có thêm trường: retryAfter cho giới hạn tần suất, reason cho hạn mức và các trường hợp bị chặn theo gói, issues cho lỗi dữ liệu đầu vào.

Mã lỗi#

Lỗi dữ liệu đầu vào#

Tham số không hợp lệ sẽ trả về 400 kèm danh sách issues chỉ ra trường gây lỗi.

{
  "error": {
    "code": "validation",
    "message": "Invalid input",
    "issues": [
      {
        "path": "pageSize",
        "message": "Invalid input"
      }
    ]
  }
}