يحدّد النوع Status
نموذج خطأ منطقيًا مناسبًا لبيئات البرمجة المختلفة، بما في ذلك واجهات برمجة تطبيقات REST وRPC. وتستخدمه gRPC. تحتوي كل رسالة Status
على ثلاثة أجزاء من البيانات: رمز الخطأ، ورسالة الخطأ، وتفاصيل الخطأ.
يمكنك معرفة المزيد من المعلومات حول نموذج الخطأ هذا وكيفية التعامل معه في دليل تصميم واجهة برمجة التطبيقات.
تمثيل JSON |
---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
الحقول | |
---|---|
code |
رمز الحالة، الذي يجب أن يكون قيمة التعداد |
message |
رسالة خطأ تواجه مطوّر البرامج، والتي يجب أن تكون باللغة الإنجليزية. يجب أن تتم ترجمة أي رسالة خطأ يواجهها المستخدم وإرسالها في الحقل |
details[] |
قائمة بالرسائل التي تحتوي على تفاصيل الخطأ. هناك مجموعة شائعة من أنواع الرسائل التي يمكن لواجهات برمجة التطبيقات استخدامها. كائن يحتوي على حقول من نوع عشوائي. يحتوي الحقل الإضافي |