หลักการออกแบบ REST API ที่ดี

REST API ที่ดีไม่ใช่แค่ทำงานได้ แต่ต้องใช้ง่าย เข้าใจง่าย และ maintain ง่าย มาดูหลักการสำคัญที่ช่วยให้ API ของคุณดีขึ้น

Naming Convention

ใช้ noun พหูพจน์สำหรับ resource เช่น /api/articles ไม่ใช่ /api/getArticles ใช้ kebab-case สำหรับ URL เช่น /api/blog-posts ไม่ใช่ /api/blogPosts ใช้ query parameters สำหรับ filtering เช่น /api/articles?category=tech&page=2

HTTP Methods ที่ถูกต้อง

GET สำหรับอ่านข้อมูล POST สำหรับสร้างใหม่ PUT สำหรับอัปเดตทั้งหมด PATCH สำหรับอัปเดตบางส่วน DELETE สำหรับลบ อย่าใช้ GET สำหรับการเปลี่ยนแปลงข้อมูล

Error Handling

ใช้ HTTP status codes ที่ถูกต้อง 200 สำเร็จ 201 สร้างสำเร็จ 400 request ไม่ถูกต้อง 401 ไม่ได้ authenticate 403 ไม่มีสิทธิ์ 404 ไม่พบ 500 server error และส่ง error message ที่ชัดเจนใน response body

บทความที่เกี่ยวข้อง