رابط برنامهنویسی کاربردی کلاس درس (Classroom API) اطلاعات خطایی را برمیگرداند که میتواند به توسعهدهندگان در اشکالزدایی مشکلات کمک کند و اطلاعات مفید و کاربردی را در اختیار کاربران نهایی قرار دهد. این راهنما نحوه تجزیه و تحلیل اطلاعات خطای برگردانده شده از رابط برنامهنویسی کاربردی (API) را توضیح میدهد.
رابط برنامهنویسی کاربردی کلاس درس، دو سطح از اطلاعات خطا را برمیگرداند:
- کد خطای HTTP در هدر.
- یک شیء در بدنه پاسخ با جزئیات بیشتر.
ساختار پیام خطا
خطاهایی که در بدنه پاسخ برگردانده میشوند شامل فیلدهای زیر هستند:
-
code: کد خطای عددی HTTP. برای مثال،403. -
message: جزئیات بیشتر در مورد خطا. در صورت وجود، پیام خطا با@و نوع خطای خاص اضافه میشود. برای مثال،@ClassroomApiDisabled. -
status: وضعیت درخواست HTTP. برای مثال،PERMISSION_DENIEDیاNOT_FOUND.
اگر درخواستی با خطای ClassroomApiDisabled شکست بخورد، پاسخ به صورت زیر خواهد بود:
{
"error": {
"code": 403,
"message": "@ClassroomApiDisabled The user is not permitted to access the Classroom API.",
"status": "PERMISSION_DENIED"
}
}
شما میتوانید از بدنهی پاسخ برای کمک به اشکالزدایی علت خطا و ارائه اطلاعات مفید به کاربران استفاده کنید. هنگام بررسی یک پیام خطای خاص، یک فاصله (space) در انتهای پیام قرار دهید تا از تطبیق مقادیر دیگری که با همان رشته شروع میشوند، جلوگیری شود. در مثال خطای ارائه شده، میتوانید بررسی کنید که آیا فیلد پیام با "@ClassroomApiDisabled " شروع میشود یا خیر تا اطلاعات مناسبی را به کاربران ارائه دهید.
برای اطلاعات بیشتر در مورد برخی از خطاهایی که میتوانند توسط Classroom API برگردانده شوند، به صفحه خطاهای رایج مراجعه کنید.