ในการใช้งาน API เพื่อดึงข้อมูลจาก Database คำที่ใช้สื่อสารหรือตั้งชื่อมักจะขึ้นอยู่กับ บริบท ( Context ) ว่าคุณกำลังพูดถึง “ตัวแปรใน Code” หรือ “กระบวนการ / Action” ครับ naming conversation จะต่างกัน
แต่ถ้าให้เลือกตามมาตรฐานสากลและความนิยม มีข้อสังเกตดังนี้ครับ
การเลือกใช้ตามหลักภาษา ( Grammar )
list_data( Noun Phase ): มักหมายถึง “รายการของข้อมูล” นิยมใช้เป็นชื่อตัวแปร ( Variable name ) เพื่อเก็บค่าที่ดึงมาจาก API หรือ Database เช่นlist_data = response.json()data_list( Noun Phase ): มีความหมายคล้ายกัน คือ “ลิสต์ที่เป็นข้อมูล” สามารถใช้แทนกันได้ในฐานะชื่อตัวแปรครับ
มาตรฐานการตั้งชื่อใน API ( Naming Convention )
หากคุณกำลังพูดถึงชื่อ Endpoint หรือชื่อ Function ในการดึงข้อมูล
- ใช้
fetch_dataหรือget_all_data: ในฝั่ง Backend นิยมใช้ Verb นำหน้าเพื่อบอก Action เช่นgetData(),fetchUserList() - ใช้คำนามพหูพจน์: หากเป็น REST API มักจะไม่ใช้คำว่า list ใน URL แต่จะใช้ชื่อ Resource เป็นพหูพจน์ไปเลย เช่น:
GET /api/users(แทนการใช้/api/list-user)GET /api/products(แทนการใช้/api/data-list-product)
ตารางเปรียบเทียบการใช้งาน
| จุดที่ใช้งาน | คำที่แนะนำ | ตัวอย่าง |
| ชื่อตัวแปร ( Variable ) | data_list หรือ items | const data_list = await db.find(); |
| ชื่อฟังก์ชัน ( Function ) | getData, listData | function listData() { ... } |
| ชื่อ Endpoint ( URL ) | ชื่อทรัพยากร ( Plural ) | https://api.example.com/v1/data |
อ่านเพิ่มเติม