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