หลังจากทดสอบ API ด้วย Swagger หรือ Postman เสร็จแล้ว ผมรู้สึกว่าการต้องมานั่งพิมพ์เอกสารแยกใน Notion ด้วยมือซ้ำ ๆ นั้นทั้งจำเจและไม่มีประสิทธิภาพ เลยสร้างเครื่องมือนี้ขึ้นมา
สิ่งที่สร้าง: เมื่ออัปโหลดไฟล์ใดก็ได้จาก Swagger/OpenAPI(.json, .yaml), Postman Collection(.json), หรือ Insomnia Export(.json) ระบบจะแปลงให้อัตโนมัติเป็นเอกสาร Markdown ที่จัดระเบียบ endpoint/parameter/ตัวอย่าง request·response ไว้เรียบร้อย สามารถคัดลอกไปวางใน Notion ได้เลย หรือดาวน์โหลดเป็นไฟล์ .md แล้วใส่ไว้ใน repo ก็ได้
วิธีลองใช้งาน: เข้าไปที่ลิงก์ด้านบนแล้วจะเจอหน้าจออัปโหลดทันที และแม้ไม่มีไฟล์อยู่ในมือ ก็มีปุ่มไฟล์ตัวอย่างแยกตาม format บนหน้าจอให้กดครั้งเดียวเพื่อดูผลลัพธ์ได้ทันที
จุดเด่น: ผมเคยเห็นเครื่องมือคล้าย ๆ ที่รองรับแค่ Swagger อย่างเดียว แต่หาเครื่องมือที่ parse ไฟล์ export ของ Postman/Insomnia แล้วแปลงเป็น format เดียวกันได้ยาก จึงตั้งใจให้ส่วนนี้เป็นจุดแตกต่าง ระบบจะดูเนื้อหาไฟล์และตรวจจับ format ให้อัตโนมัติ
ตอนนี้ยังไม่มีฟีเจอร์ login และ Insomnia ยังดึงได้ไม่ถึงตัวอย่าง response เป็นต้น ยังอยู่ในขั้น MVP ระยะแรก หากลองใช้งานจริงแล้วมีจุดที่ไม่สะดวก หรือมีความเห็นว่าอยากให้รองรับ format แบบไหนเพิ่มเติม ฝากคอมเมนต์ไว้ได้เลยครับ
บทความที่เขียนเล่าเพิ่มเติมเล็กน้อยว่าทำไมถึงสร้างไว้ที่นี่: https://velog.io/@dkslasdud/…
ยังไม่มีความคิดเห็น