API Lớp học trả về thông tin lỗi có thể giúp nhà phát triển gỡ lỗi và cung cấp thông tin hữu ích, thiết thực cho người dùng cuối. Hướng dẫn này giải thích cách phân tích cú pháp thông tin lỗi được trả về từ API.
API Lớp học trả về hai cấp độ thông tin lỗi:
- Mã lỗi HTTP trong tiêu đề.
- Một đối tượng trong phần nội dung phản hồi có thêm thông tin chi tiết.
Cấu trúc thông báo lỗi
Các lỗi được trả về trong phần nội dung phản hồi bao gồm các trường sau:
code: Mã lỗi HTTP dạng số. Ví dụ:403.message: Thông tin chi tiết khác về lỗi. Khi có, thông báo lỗi sẽ được thêm vào trước bằng@và một loại lỗi cụ thể. Ví dụ:@ClassroomApiDisabledstatus: Trạng thái yêu cầu HTTP. Ví dụ:PERMISSION_DENIEDhoặcNOT_FOUND.
Nếu một yêu cầu không thành công với lỗi ClassroomApiDisabled, thì phản hồi sẽ là:
{
"error": {
"code": 403,
"message": "@ClassroomApiDisabled The user is not permitted to access the Classroom API.",
"status": "PERMISSION_DENIED"
}
}
Bạn có thể sử dụng phần nội dung phản hồi để gỡ lỗi nguyên nhân gây ra lỗi và cung cấp thông tin hữu ích cho người dùng. Thêm dấu cách ở cuối khi kiểm tra thông báo lỗi cụ thể để tránh so khớp các giá trị khác bắt đầu bằng cùng một chuỗi. Trong ví dụ về lỗi được cung cấp, bạn có thể kiểm tra xem trường thông báo có bắt đầu bằng "@ClassroomApiDisabled " hay không để hiển thị thông tin thích hợp cho người dùng.
Tham khảo các trang lỗi truy cập, lỗi yêu cầu và lỗi tiện ích bổ sung để biết thông tin về một số lỗi mà API Lớp học có thể trả về.