בסוג Status
מוגדר מודל שגיאה לוגית שמתאים לסביבות תכנות שונות, כולל ממשקי REST API ו-RPC API. הפרמטר הזה משמש את gRPC. כל הודעת Status
מכילה שלושה נתונים: קוד שגיאה, הודעת שגיאה ופרטי שגיאה.
במדריך לעיצוב API מפורט מידע נוסף על מודל השגיאה הזה והסבר איך להשתמש בו.
ייצוג JSON |
---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
שדות | |
---|---|
code |
קוד הסטטוס, שצריך להיות ערך 'טיפוסים בני מנייה (enum)' של |
message |
הודעת שגיאה למפתחים, שאמורה להיות באנגלית. כל הודעת שגיאה שמוצגת למשתמש צריכה לעבור לוקליזציה ולשלוח בשדה |
details[] |
רשימה של הודעות שמציגות את פרטי השגיאה. יש קבוצה משותפת של סוגי הודעות בממשקי API שבהם אפשר להשתמש. אובייקט שמכיל שדות מסוג שרירותי. שדה נוסף |