ทดสอบ Api ด้วย postman



    นี่เป็นบทความต่อเนื่องจาก การสร้าง rest api ตอนที่ 4 โดย api โดยใช้ทดสอบ todo api มีบทความสำหรับ

สอนสร้างชื่อ การสร้าง rest api ตอนที่ 1 ถ้าสร้างเสร็จแล้วก็มาเริ่มเนื้อหากัได้เลย

    หลังจากสร้าง api เสร็จแล้วให้ทำการทดสอบใช้งาน api มีเครื่องมือตัวหนึ่งชื่อ postman สามารถใช้งาน

ทดสอบ api ได้  เริ่มต้นให้ดาวน์โหลด postman มาติดตั้งบนเครื่องก่อน  ที่เว็บ https://www.postman.com/



เมื่อติดตั้งเสร็จแล้วจะได้หน้าตาโปรแกรมเป็นดังรูปด้านล่างนี้



หลังจากนั้นให้คลิกปุ๋ม new collection เพื่อไว้สำหรับเก็บ url ทั้งหมดที่เราใช้ทดสอบ api



หลังจากนั้นให้ตั้งชื่อ collection แล้วคลิก create ตามรูปด้านล่าง  ในที่นี้ตั้งชื่อว่า api



หลังจากสร้างเสร็จจะได้ collection ชื่อ api ตามที่เราสร้างตามรูปด้านล่าง


มาทดสอบ api แรกที่การ add todo ให้เรานำ url เป็น localhost:8000/api/v1/addTodo มาใส่  และให้เลือก

method เป็น post ด้วย  จากนั้นส่วนข้อมูลที่ต้องการส่งให้แเลือกเป็น body ก่อน  จากนั้นจะมีชนิดของเนื้อหา

ให้เลือกอีกโดยให้เราเลือก raw จากนั้นให้เลือกชนิดเป็น json ส่วนเนื้อหาข้อมูลข้างในให้ใส่ข้อมูลที่อยู่ใน

รูปแบบ json เข้าไป  จากรูปด้านล่างเป็นการส่งชื่อ name เป็น poster ไว้สำหรับสร้าง todo พอใส่ข้อมูล

เสร็จแล้วให้คลิก save



พอคลิก save จะมีแถบให้ตั้งชื่อ request โดยเราจะนำการทดสอบนี้กลับมาใช้ซ้ำได้  จากนั้นให้เลือก

collection ที่ต้องการ save เป็น api ตามชื่อที่เราสร้างเป็น collection ไว้ในตอนแรก  เสร็จแล้วให้คลิก save



หลังจาก save แล้วก็มาลองส่ง request เพื่อดูผลลัพธ์  ถ้า api ทำงานถูกต้องก็จะได้ผลดัง

รูปด้านล่าง  การทดสอบแบบนี้ถ้าผลลัพธ์ของ api ไม่เป็นไปตามที่ต้องการก็กลับแก้โค้ดของ api จนกว่า

จะได้ผลลัพธ์ตามที่ต้องการ  ผลลัพธ์จากการส่ง request จะอยู่ใต้แถบที่เราใช้ส่งข้อมูลนะในรูปตัวอย่าง

นีและทุกตัวอย่างต่อๆไปคือคลิก send ไปแล้วเลยเห็นภาพผลลัพธ์ติดมาด้วย



ต่อไปเป็นการทดสอบ api สำหรับอ่านข้อมูล todo ทั้งหมด โดยใช้ url เป็น localhost:8000/api/v1/getAllTodo

ให้เลือก method เป็น get แล้วคลิก send เพื่อดูผลลัพธ์โดยจะได้ todo ที่เราพึ่งสร้างแสดงออกมาให้เห็น 

เสร็จแล้วให้ save ด้วย  แนะนำให้ save ทุก request ที่เราใช้ทดสอบ



ต่อไปเป็นการทดสอบ api การแก้ไขข้อมูล todo โดยให้ใช้ url เป็น localhost:8000/api/v1/updateTodo

ใช้ method เป็น post เลือกส่ง body แบบ raw ชนิด json เหมือนกับของ addTodo เลยแต่อันนี้ข้อมูลที่

ส่งให้ระบุ id ไปด้วยเพราะเป็นการแก้ไขข้อมูลเลยให้ระบุ id ของข้อมูลที่ต้องการแก้ไขไปพร้อมกับข้อมูล

ใหม่ด้วย  ตามตัวอย่างรูปด้านล่าง



ต่อไปเป็นการทดสอบ api อ่านข้อมูลตาม id ใช้ url เป็น localhost:8000/api/v1/getTodo ใช้ method

เป็น get นี่เป็นการอ่านข้อมูลทีละตัวตาม id ที่กำหนดผลลัพธ์ที่ได้จะเป็นข้อมูลตาม id ที่เราส่งไป 

ถ้าไม่มีข้อมูลใน id นี้ก็จะไม่ได้ข้อมูล  การส่งข้อมูลไปกับ request จะเป้นรูปแบบของ parameter โดย

ให้เลือก Params จากนั้นกำหนด key เป็น id และกำหนด value เป็น 0 นั่นคือส่ง id=0 ไปนั่นเองหลัง

จากตั้งค่าตรงนี้แล้ว url ของเราจะเปลี่ยนเป็น localhost:8000/api/v1/getTodo?id=0 โดยอัตโนมัติเพราะ

การส่ง parameter ไปกับ url มีรูปแบบเป็นแบบนี้  ที่เรามากรอกข้อมูลใน form เพราะช่วยให้

เรียบเรียงข้อมูลได้ง่ายขึ้นเฉยๆ  ตามตัวอย่างรูปด้านล่าง



สุดท้ายนี้เป็นการลบข้อมูลตาม id ที่กำหนด  ใช้ url เป็น localhost:8000/api/v1/deleteTodo ใช้ method

เป็น post เลือกส่งข้อมูลผ่าน bpdy แบบ raw ชนิด json โดยส่งค่า id ของข้อมูลที่ต้องการลบออกไป 

หลังจากทดสอบส่ง request นี้ไปแล้วให้ลองกลับไปส่ง request getAllTodo จะพบว่าข้อมูล todo

หายไปเพราะเราสั่งลบไปแล้ว


    นี่เป็นตัวอย่างการใช้ postman เบื้องต้นเท่านั้นแต่เพียงเท่านี้ก็สามารถทดสอบใช้ api ได้แล้ว


ความคิดเห็น