3.1

หนึ่งคำขอ (Request) ประกอบด้วย 4 ส่วน

ทุกครั้งที่เรียกใช้ API คำขอหนึ่งชุดจะมีองค์ประกอบหลัก 4 ส่วน หากเข้าใจ 4 ส่วนนี้ ผู้เรียนจะสามารถอ่านเอกสาร API และทดลองเรียกใช้งาน API ได้อย่างเป็นระบบ

ส่วนประกอบความหมายเปรียบเทียบกับร้านอาหาร
Methodระบุเจตนาว่าต้องการทำอะไรดูข้อมูล / สั่งอาหาร / ยกเลิกคำสั่ง
URL (endpoint)ที่อยู่ของปลายทางที่ต้องการเรียกใช้โต๊ะหรือเมนูที่ต้องการสั่ง
Headersข้อมูลกำกับคำขอ เช่น ข้อมูลยืนยันสิทธิ์บัตรสมาชิกหรือภาษาที่ต้องการใช้บริการ
Bodyข้อมูลหลักที่ส่งไปกับคำขอรายละเอียดของรายการที่สั่ง

Method ที่พบบ่อย 4 แบบ

Methodความหมายตัวอย่างในร้าน
GETดูข้อมูลดูเมนู
POSTส่งข้อมูลหรือสร้างรายการใหม่สั่งอาหาร 1 จาน
PUT / PATCHแก้ไขข้อมูลเดิมเปลี่ยนรายการอาหาร
DELETEลบข้อมูลยกเลิกคำสั่งซื้อ

โดยทั่วไป GET ใช้สำหรับขอดูข้อมูล จึงมักไม่ต้องมี Body ส่วน POST ใช้สำหรับส่งข้อมูลใหม่ จึงต้องแนบ Body เพื่อระบุรายละเอียด