รหัสสถานะ HTTP
เอกสารนี้กำหนดข้อกำหนดรหัสสถานะ HTTP สำหรับ REST API
การกำหนดรหัสสถานะ
| รหัส | คำอธิบาย | รายละเอียด |
|---|---|---|
| 200 | OK | สำเร็จ! |
| 400 | คำขอไม่ถูกต้อง | คำขอไม่ถูกต้อง รายละเอียดที่เกี่ยวข้องจะอธิบายสาเหตุ |
| 401 | ไม่ผ่านการตรวจสอบ | ไม่มีข้อมูลการตรวจสอบหรือการตรวจสอบล้มเหลว |
| 403 | ปฏิเสธ | คำขอได้รับการเข้าใจแต่ไม่ได้รับการยอมรับ รายละเอียดที่เกี่ยวข้องจะอธิบายสาเหตุ |
| 404 | ไม่พบ | ทรัพยากรไม่พบ ผู้ใช้ที่ร้องขอไม่มีอยู่ หรือรูปแบบคำขอไม่รองรับ |
| 405 | วิธีการคำขอไม่เหมาะสม | อินเทอร์เฟซไม่รองรับวิธีการคำขอนี้ |
| 410 | เลิกใช้งานแล้ว | ทรัพยากรที่ร้องขอเลิกใช้งานแล้ว โปรดดูประกาศที่เกี่ยวข้อง |
| 429 | คำขอมากเกินไป | คำขอเกินขีดจำกัดความถี่ รายละเอียดที่เกี่ยวข้องจะอธิบายสาเหตุเฉพาะ |
| 500 | ข้อผิดพลาดภายในเซิร์ฟเวอร์ | เซิร์ฟเวอร์เกิดข้อผิดพลาดภายใน โปรดติดต่อเราเพื่อแก้ไขปัญหาโดยเร็วที่สุด |
| 502 | พร็อกซีไม่ถูกต้อง | เซิร์ฟเวอร์บริการเลิกใช้งานหรือกำลังอัปเกรด โปรดลองอีกครั้งในภายหลัง |
| 503 | บริการล้มเหลวชั่วคราว | เซิร์ฟเวอร์ไม่สามารถตอบสนองคำขอได้ โปรดลองอีกครั้งในภายหลัง |
| 504 | พร็อกซีหมดเวลา | เซิร์ฟเวอร์กำลังทำงานแต่ไม่สามารถตอบสนองคำขอได้ โปรดลองอีกครั้งในภายหลัง |
ข้อกำหนดที่ต้องปฏิบัติตาม
- 200 ต้องถูกต้อง ห้ามใช้รหัสสถานะ 200 สำหรับข้อยกเว้นทั้งหมด
- สำหรับข้อผิดพลาดทางตรรกะทางธุรกิจ ให้ใช้รหัสข้อผิดพลาด 4xx ที่เฉพาะเจาะจง หากไม่มี ให้ใช้ 400
- ข้อผิดพลาดภายในเซิร์ฟเวอร์ หากไม่มีรหัสข้อผิดพลาดเฉพาะ ให้ใช้ 500
- เมื่อเกิดข้อยกเว้นทางธุรกิจ ให้ใช้รูปแบบ JSON ในการส่งคืนข้อมูลข้อผิดพลาด
