Classroom API מחזיר מידע על שגיאות שיכול לעזור למפתחים לנפות באגים ולספק למשתמשי הקצה מידע שימושי ופרקטי. במדריך הזה מוסבר איך לנתח את פרטי השגיאה שמוחזרים מה-API.
ב-Classroom 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"
}
}
אפשר להשתמש בגוף התגובה כדי לנפות באגים ולמצוא את הגורם לשגיאה, וכדי לספק למשתמשים מידע שימושי. אם מחפשים הודעת שגיאה ספציפית, צריך להוסיף רווח בסוף כדי למנוע התאמה לערכים אחרים שמתחילים באותה מחרוזת. בדוגמה לשגיאה שמופיעה למעלה, אפשר לבדוק אם השדה message מתחיל ב-"@ClassroomApiDisabled " כדי להציג למשתמשים את המידע המתאים.
בדף השגיאות הנפוצות מפורטות חלק מהשגיאות שיכולות להתקבל מ-Classroom API.