กำหนดรหัสสถานะในการตอบกลับ JSON

การตอบกลับ HTTP ทุกครั้งมี รหัสสถานะที่บอกว่าดำเนินการสำเร็จหรือล้มเหลว เนื้อหา JSON อธิบายรายละเอียด แต่รหัสจะกำหนดความหมายเบื้องต้นก่อน 🚦

เมื่อคุณส่งคืน jsonify เพียงอย่างเดียว Flask จะส่ง 200 OK ซึ่งเหมาะสำหรับการอ่านที่สำเร็จ แต่การดำเนินการอื่นควรใช้รหัสของตนเอง

หากต้องการเลือกรหัส ให้ส่งคืน ทูเพิลที่ประกอบด้วยการตอบกลับ JSON และตัวเลข Flask จะอ่านสมาชิกตัวที่สองเป็นสถานะ HTTP ที่ต้องส่ง

เมื่อคำขอสร้างระเบียนใหม่ ให้ตอบกลับด้วย 201 Created เพื่อบอกไคลเอ็นต์ว่าทรัพยากรมีอยู่แล้ว ซึ่ง 200 เพียงอย่างเดียวไม่สามารถสื่อความหมายนี้ได้

หากไม่มีรายการที่ร้องขอ ให้ส่งคืนเนื้อหา JSON พร้อม 404 ไคลเอ็นต์จะทราบว่าทรัพยากรหายไป ไม่ใช่ว่าเซิร์ฟเวอร์เสีย

เมื่อลูกค้าส่งข้อมูลที่ไม่ถูกต้อง ให้ตอบกลับด้วย 400 Bad Request และแนบข้อความ JSON ที่อธิบายอย่างชัดเจนว่าเกิดข้อผิดพลาดตรงไหน

รหัสในช่วง 2xx หมายถึงความสำเร็จ 200 ใช้สำหรับการอ่าน 201 ใช้สำหรับการสร้าง และ 204 หมายถึงสำเร็จโดยไม่มีเนื้อหาที่ต้องส่งกลับ

รหัสในช่วง 4xx ชี้ว่าปัญหาเกิดจากไคลเอ็นต์ 400 หมายถึงข้อมูลนำเข้าไม่ถูกต้อง 401 หมายถึงยังไม่ได้ยืนยันตัวตน และ 403 หมายถึงไม่ได้รับอนุญาต

รหัสในช่วง 5xx ชี้ว่าปัญหาเกิดจากเซิร์ฟเวอร์ 500 หมายถึงโค้ดของคุณก่อให้เกิดข้อผิดพลาดที่ไม่ได้จัดการขณะประมวลผลคำขอที่ถูกต้อง

คุณสามารถขยายทูเพิลให้มีสามส่วน ได้แก่ เนื้อหา สถานะ และพจนานุกรม ส่วนหัว ทำให้คุณแนบข้อมูลกำกับเพิ่มเติมได้ในการส่งคืนครั้งเดียวอย่างเป็นระเบียบ

เลือกรหัสที่เหมาะสมกับผลลัพธ์ทุกแบบและใช้ให้เหมือนกันทุกแห่ง รหัสสถานะที่ สม่ำเสมอทำให้ API ของคุณคาดเดาได้และเชื่อมต่อใช้งานได้อย่างราบรื่น

คุณได้เรียนรู้การจับคู่เนื้อหา JSON กับ รหัสสถานะที่ถูกต้องด้วยการส่งคืนทูเพิล โดยใช้ 201, 404 และ 400 เพื่อทำให้ API ของคุณชัดเจนและตรงไปตรงมา ✅