Cấu trúc lỗi API Google Lớp học

Classroom API 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 do API trả về.

Classroom API trả về 2 cấp độ thông tin lỗi:

  • Mã lỗi HTTP trong tiêu đề.
  • Một đối tượng trong nội dung phản hồi có thông tin chi tiết bổ sung.

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 bằng số. Ví dụ: 403.
  • message: Thông tin chi tiết khác về lỗi. Khi có sẵn, thông báo lỗi sẽ được thêm tiền tố @ và một loại lỗi cụ thể. Ví dụ: @ClassroomApiDisabled
  • status: Trạng thái yêu cầu HTTP. Ví dụ: PERMISSION_DENIED hoặc NOT_FOUND.

Nếu một yêu cầu không thành công do 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 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 một khoảng trắng ở cuối khi kiểm tra một thông báo lỗi cụ thể để tránh trùng khớp với 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 để trình bày thông tin phù hợp cho người dùng.

Tham khảo trang Các lỗi thường gặp để biết thông tin về một số lỗi mà Classroom API có thể trả về.

Tiếp
Thông báo lỗi thường gặp