insomnia documenter
v0.5.5
เช่นเดียวกับบุรุษไปรษณีย์ Documenter แต่สำหรับการนอนไม่หลับ! ด้วยเครื่องมือนี้ คุณสามารถสร้างหน้าเอกสารประกอบ API ที่สวยงามได้โดยใช้ไฟล์ส่งออก Insomnia ของคุณ
สาธิต: https://insodoc.github.io/insomnia-documenter/
วิดีโอสอนและสาธิต: https://www.youtube.com/watch?v=pq2u3FqVVy8
npxInsomnia Documenter มีเครื่องมือ CLI ที่ช่วยให้การตั้งค่าหน้าเอกสารเป็นเรื่องง่ายมาก คุณสามารถใช้มันได้สองวิธี
npx npx insomnia-documenter --config /path/to/insomnia/config.jsonnpm i -g insomnia-documenter
insomnia-documenter --config /path/to/insomnia/config.json Options:
-c, --config <location> Location of the exported Insomnia JSON config.
-l, --logo <location> Project logo location (48x48px PNG).
-f, --favicon <location> Project favicon location (ICO).
-o, --output <location> Where to save the file (defaults to current working directory).
-h, --help output usage information
หรือคุณสามารถเริ่มใช้ Insomnia Documenter ได้โดยดาวน์โหลดไฟล์เก็บถาวรเผยแพร่จาก GitHub และเพิ่มไฟล์ส่งออก insomnia.json ลงในไดเร็กทอรีรากของไซต์ของคุณ
การอัปเดต API นั้นง่ายมาก! เนื่องจาก Insomnia Documenter เป็นเว็บแอป Plug-and-Play คุณจึงสามารถแทนที่ insomnia.json ด้วยไฟล์ JSON ที่ส่งออกใหม่ของคุณได้ เพียงตรวจสอบให้แน่ใจว่ามันเรียกว่า insomnia.json
เช่นเดียวกับโลโก้ ( logo.png ) และ favicon ( favicon.ico ) ด้วยเช่นกัน
บางทีคุณอาจต้องการจัดทำเอกสาร API หลายรายการในโดเมนเดียวกัน บางทีคุณอาจต้องการโฮสต์หน้าเอกสารของคุณบนหน้า GitHub? ในกรณีนี้ (อื่นๆ อีกหลายกรณี) คุณจะต้องระบุว่าเส้นทางรากคืออะไร เมื่อต้องการทำเช่นนี้ คุณต้องเปิด index.html และแทนที่บรรทัดต่อไปนี้:
< div id =" app " > </ div >ด้วยสิ่งนี้:
< div id =" app " data-root =" /path/to/docs " > </ div > ในกรณีนี้ แอปจะรับไฟล์ insomnia.json จากไดเร็กทอรี /path/to/docs วิธีนี้ช่วยให้คุณมีความยืดหยุ่นมากขึ้นเกี่ยวกับวิธีการดูแลหน้าเอกสารประกอบของคุณ (เช่น คุณสามารถจัดเก็บไฟล์ส่งออกไว้ที่อื่นที่ไม่ใช่ไดเร็กทอรีรากของหน้าเว็บ) คุณไม่ควรใส่เครื่องหมายสแลชต่อท้ายในคุณสมบัติ data-root
โปรดทราบว่าการตั้งค่าแอตทริบิวต์นี้จะไม่ส่งผลต่อไอคอน Fav และโลโก้ของเพจ พวกเขาจะยังคงโหลดจากไดเร็กทอรีเดียวกันกับที่ index.html อยู่
การเปิดไฟล์ index.html จะไม่สามารถโหลดได้ในกรณี 99.9% เนื่องจากนั่นเป็นวิธีการทำงานของการดึงข้อมูล หากต้องการดูตัวอย่างเพจในเครื่อง คุณอาจต้องการใช้เครื่องมือ เช่น zeit/serve:
npx serveหน้านี้จะมีอยู่ที่ http://localhost:5000
devhammed ได้สร้างปลั๊กอิน Insomnia ที่ยอดเยี่ยมซึ่งช่วยให้คุณสามารถสร้างหน้าเอกสารประกอบได้โดยตรงจากอินเทอร์เฟซของ Insomnia รับปลั๊กอิน (npm - github)
โปรดดูเอกสารบันทึกการเปลี่ยนแปลง
เครื่องมือ CLI เป็นแอปเพล็ต Commander ในขณะที่ส่วนหน้านั้นเป็นแอป Svelte โปรเจ็กต์นี้ยังอยู่ในช่วงเบต้า ซึ่งหมายความว่ามีข้อบกพร่องและสามารถปรับปรุงได้ที่นี่และที่นั่น ยินดีเป็นอย่างยิ่ง :)
โคลนที่เก็บ:
git clone [email protected]:jozsefsallai/insomnia-documenter.git
cd insomnia-documenterติดตั้งการพึ่งพา:
npm installคัดลอกไฟล์ส่งออกสาธิต Insomnia:
cp docs/insomnia.json public/insomnia.jsonรันบิลด์การพัฒนาด้วย hot reload:
npm run devสร้างงานสร้างการผลิต:
npm run buildขุย:
npm run lintการทดสอบ:
npm run test เอ็มไอที.
หมายเหตุ: โครงการนี้ไม่มีส่วนเกี่ยวข้องกับก้อง และ/หรือ โรคนอนไม่หลับ
มีให้เป็นส่วนหนึ่งของการสมัครสมาชิก Tidelift
ผู้ดูแล Insomnia Documenter และแพ็คเกจอื่นๆ หลายพันรายการกำลังทำงานร่วมกับ Tidelift เพื่อให้การสนับสนุนเชิงพาณิชย์และการบำรุงรักษาสำหรับการพึ่งพาโอเพ่นซอร์สที่คุณใช้ในการสร้างแอปพลิเคชันของคุณ ประหยัดเวลา ลดความเสี่ยง และปรับปรุงประสิทธิภาพของโค้ด ในขณะเดียวกันก็จ่ายค่าตอบแทนให้กับผู้ดูแลตามที่คุณใช้ เรียนรู้เพิ่มเติม
