ออกแบบ API ให้ดีตั้งแต่แรก ไม่ต้องแก้ทีหลัง
หลักการออกแบบ REST API ที่ดีซึ่งนักพัฒนาหน้าใหม่มักมองข้าม ทำให้ระบบขยายง่ายและ maintain ได้ในระยะยาว
ออกแบบ API ให้ดีตั้งแต่แรก ไม่ต้องแก้ทีหลัง
API ที่ออกแบบไม่ดีตั้งแต่แรกจะกลายเป็นหนี้เทคนิคที่แก้ยากมากในภายหลัง โดยเฉพาะเมื่อมี client ใช้งานแล้ว
ใช้ HTTP Methods ให้ถูกต้อง
GET สำหรับดึงข้อมูล POST สำหรับสร้าง PUT/PATCH สำหรับแก้ไข DELETE สำหรับลบ อย่าใช้ GET สำหรับทุกอย่างเพราะสะดวก
ตั้งชื่อ Endpoint ด้วย Noun ไม่ใช่ Verb
ใช้ /users ไม่ใช่ /getUsers ใช้ /orders/123 ไม่ใช่ /getOrderById?id=123 ให้ HTTP method บอก action แทน
Version API เสมอ
เพิ่ม version ใน URL เช่น /api/v1/users ตั้งแต่วันแรก เมื่อต้อง breaking change จะได้ออก /api/v2 โดยไม่กระทบ client เดิม
Response Format ที่สม่ำเสมอ
กำหนด format response ให้เหมือนกันทุก endpoint เช่น มี data, message, และ status เสมอ ทั้ง success และ error
HTTP Status Code ที่ถูกต้อง
ส่ง 200 เมื่อสำเร็จ 201 เมื่อสร้างใหม่ 400 เมื่อ request ผิด 401 เมื่อยังไม่ login 404 เมื่อหาไม่เจอ 500 เมื่อ server error อย่าส่ง 200 พร้อม error message ใน body
API ที่ดีคือ API ที่นักพัฒนาคนอื่นใช้แล้วรู้เรื่องโดยไม่ต้องอ่าน documentation มากนัก