Explicit Knowledge เรื่อง การสร้าง API Document ด้วย Postman

วิธีสร้าง  API Document

1. ไปที่ Tab Collection แล้วกดปุ่มเพิ่ม แล้วตั้งชื่อ API Document

2. กด Add a request

3. เพิ่มข้อมูล API ที่เราจะทำการทดสอบ

4. จากข้อที่ 3 ที่เราทดสอบเรียก API เจ้าตัว Postman สามารถ Gen ออกมาเป็น API Documentให้เราได้เลย

หลังจากกด View documentation แล้วจะพบหน้าจอแบบนี้ หากเราต้องการ แชร์ API Document ให้ทีมหรือคนอื่นๆ ให้กดปุ่ม Publish

หลังจากคลิกปุ่ม Publish แล้วโปรแกรมจะเปิดหน้าเว็บขึ้นมา 1 หน้า ให้ใช้ค่าเริ่มต้นของหน้าเว็บนั้นเลยก็ได้แล้วกดปุ่ม Publish อีกครั้ง

หลังจากคลิกปุ่ม Publish แล้ว หน้าเว็บจะมีลิงก์ที่เป็น published documentation ขึ้นมา เราสามารถนำลิงก์นี้ไปแชร์ให้คนในทีมหรือคนอื่นๆได้

ทดสอบเปิดลิงก์ก็จะพบกับ API Document หน้าตาดังรูป ซึ่งหน้าตาอาจจะดูแปลกๆ เพราะ Document ยังไม่สมบูรณ์

5. วิธีการเพิ่มตัวอย่าง Response ใน API Documentในการพัฒนา API นั้น Response ที่ได้กลับมาอาจจะมีหลายแบบเราจะเพิ่มยังไงให้แสดงใน API Document

ถ้ากลับไปดูที่ลิงก์ API Document ของเรา ก็จะมี Example Response เพิ่มขึ้นมา

ถ้ามี Example Response หลายอันเราสามารถเลือกดูผล Response ได้ ดังรูป

6. การใช้งาน API Documentผู้พัฒนาในทีมสามารถกดปุ่ม Run in Postman แล้วเปลี่ยนข้อมูลต่างๆที่ใช้เรียก API แล้วรันเทส API ได้เลย จะทำให้ประหยัดเวลาและง่ายต่อการทำงาน

หมายเหตุ : หากเรามีการปรับแก้ตัว API หรือปรับแก้ข้อมูลที่ใช้ส่ง API ไปหลังจากเรากด Save ลิงก์ API Document ที่แชร์อยู่จะมีการอัพเดทตามที่เราแก้โดยอัตโนมัติ

ตัวอย่างการใช้งานจริง : https://to.buu.ac.th/5aspaip