ประเภท Status
จะกำหนดโมเดลข้อผิดพลาดเชิงตรรกะที่เหมาะสำหรับสภาพแวดล้อมการเขียนโปรแกรมที่แตกต่างกัน รวมถึง REST API และ RPC API มันถูกใช้โดย gRPC ข้อความ Status
แต่ละข้อความประกอบด้วยข้อมูลสามส่วน: รหัสข้อผิดพลาด ข้อความแสดงข้อผิดพลาด และรายละเอียดข้อผิดพลาด
คุณสามารถดูข้อมูลเพิ่มเติมเกี่ยวกับโมเดลข้อผิดพลาดนี้และวิธีการทำงานกับโมเดลข้อผิดพลาดนี้ได้ใน คู่มือการออกแบบ API
การเป็นตัวแทน JSON |
---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
เขตข้อมูล | |
---|---|
code | รหัสสถานะ ซึ่งควรเป็นค่าแจงนับของ |
message | ข้อความแสดงข้อผิดพลาดที่ผู้พัฒนาพบ ซึ่งควรเป็นภาษาอังกฤษ ข้อความแสดงข้อผิดพลาดที่ผู้ใช้พบควรได้รับการแปลและส่งในช่อง |
details[] | รายการข้อความที่มีรายละเอียดข้อผิดพลาด มีชุดประเภทข้อความทั่วไปสำหรับ API ที่จะใช้ วัตถุที่มีฟิลด์ประเภทใดก็ได้ ฟิลด์เพิ่มเติม |