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