Postman ก็สร้าง API Test Report ได้ 😱

สำหรับคนมีเวลาอ่านน้อย

• Newman คือ Command Line สำหรับ run Collection Runner ของ Postman
• Newman สามารถ generate test report หลังจากที่เราเขียน test script ใน Postman ได้

ยังไม่มีเวลาอ่าน🔖 Bookmark บทความนี้ไว้อ่านทีหลังได้เลยยย

Postman เป็น tool ที่สามารถใช้ได้กับทุกๆตำแหน่ง ไม่ว่าจะเป็น SA, Developer หรือแม้กระทั่ง Tester ก็สามารถใช้งานได้ ด้วยความที่ postman เป็น tool ที่ใช้ง่าย และสะดวกมาก สำหรับการใช้ยิงเพื่อดู response ของ API เส้นที่ต้องการ, ใช้สำหรับสร้าง Documentation หรือ API specifications เพื่อให้คนในทีมเข้าใจ spec ได้ตรงกัน และสำหรับ tester อย่างเราก็สามารถใช้ postman ในการเขียน test script สั้น ๆ ง่าย ๆ เพื่อใช้ทดสอบ API ได้เช่นกัน

ถึงแม้ว่า postman จะสามารถเขียน test script และ execute script ในตัวได้เลย แต่ก็ไม่สามารถ generate test report ออกมาเพื่อ deliver ให้กับSA และลูกค้าดูได้ postman จึงมีตัวช่วยที่ชื่อว่า newman ที่จะสามารถ generate report ออกมา และทำให้เรามี test report แบบ minimal ออกมาดูได้

ก่อนอื่นเลยเราจะต้องติดตั้งเจ้า newman ลงในเครื่องของเราก่อน

$ npm install -g newman

หลังจากนั้นให้เราไปทำการ export ไฟล์ JSON ของ collection ที่เราเขียน test script ไว้ออกมา

เมื่อได้ไฟล์ JSON จากนั้นเราก็ generate test report โดยใช้

$ newman run <mycollection>.json --reporters html --reporter-html-export <outputfile>.html

เราก็จะได้ test report ที่หน้าตา minimal หน่อย ๆ เหมือนกับตัวอย่างที่นำมาให้ดู

ตัวอย่าง Total Report

ตัวอย่าง Request Test Peport

สำหรับใครที่อยากได้ report ที่มีสีสันมีชีวิตชีวา สามารถลง libraly เสริมสำหรับการ generate report ให้อยู่ในรูปของ dashboard ได้ โดยใช้คำสั่งด้านล่างติดตั้ง

$ npm install -g newman-reporter-htmlextra

จากนั้นเราก็สามารถใช้ newman-reporter-htmlextra สร้าง report ได้เลย

$ newman run <mycollection>.json -r htmlextra

เราสามารถใช้ --reporter-htmlextra-export เพื่อกำหนดชื่อให้กับไฟล์ของ report เราได้เช่น

$ newman run <mycollection>.json -r htmlextra --reporter-htmlextra-export ./results/report.html

เราจะได้ไฟล์ report.html ที่อยู่ในโฟลเดอร์ results เมื่อเปิดไฟล์ขึ้นมาเราจะได้หน้าตา report ประมาณนี้

หน้าตาจะออกมาเป็น dashboard ที่มีสีสันเยอะ(สามารถเปลี่ยน light/dark mode ได้ด้วยยย😆) ต่างจาก report อันแรกที่ออกแนว minimal ของเรา ซึ่งสิ่งที่ report นำมาแสดงของทั้งสองแบบแทบจะไม่ต่างกันเลย จะมีแค่ส่วนของ header ที่ report แบบที่สองนำมาแสดงให้ดู ถ้าถามว่าควรเลือกใช้แบบไหนดี ก็ควรเลือกใช้ให้เหมาะสมกับงานแต่ละงานที่เราได้รับมา

หลังจากที่ได้ API test report มาก็สามารถส่งไฟล์ report.htmlให้คนอื่นดูได้เลย หรือจะนำไฟล์ report.html ขึ้น firebase ก่อนที่จะส่งต่อให้คนอื่นก็ได้

ตัวอย่าง Report

Newman Report Example1

Newman Report Example2

ตัวอย่าง Postman Collection

nuswee43/newmanforblog

สรุป

สำหรับคนที่ใช้ postman อยู่แล้ว newman เป็นอีกหนึ่งตัวเลือกสำหรับการ test API เพื่อทดสอบความถูกต้องของ API และยังสามารถส่งต่อ report ไปให้กับคนในทีมหรือลูกค้าดูได้อย่างง่ายและรวดเร็ว นอกจากนี้ newman ยังมี library ที่สามารถสร้าง dashboard report ที่สวยงามให้เราได้ใช้อีก😝

บทความนี้เขียนด้วยความคิดเห็นส่วนตัวของเจ้าของบล็อก ถ้าผิดพลาดประการใดสามารถให้คำแนะนำได้ ถ้าชอบบทความนี้ (หรือคนเขียน🥴) อย่าลืม 👏 (Claps) และ 🔖 (Bookmark) บทความนี้ไว้อ่านทีหลังได้น้าาา

Reference📚

postmanlabs/newman

Running collections on the command line with Newman

newman-reporter-htmlextra