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