insomnia documenter
v0.5.5
就像郵差記錄員，但針對失眠！借助此工具，您可以使用 Insomnia 匯出檔案產生漂亮的 API 文件頁面。
示範：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
或者，您可以從 GitHub 下載發布檔案並將insomnia.json匯出檔案新增至網站的根目錄來開始使用 Insomnia Documenter。
更新 API 非常簡單！由於 Insomnia Documenter 是一個即插即用的 Web 應用程序，因此您只需將insomnia.json替換為新匯出的 JSON 檔案即可。只要確保它的名稱為insomnia.json即可。
這實際上也適用於標誌 ( logo.png ) 和網站圖示 ( favicon.ico )。
也許您想在同一網域上記錄多個 API？也許您想在 GitHub 頁面上託管您的文件頁面？在這種情況下（任何許多其他情況），您將需要指定根路徑是什麼。為此，您必須打開index.html並替換以下行：
< div id =" app " > </ div >像這樣的東西：
< div id =" app " data-root =" /path/to/docs " > </ div >在這種情況下，應用程式將從/path/to/docs目錄中取得insomnia.json檔案。這使您可以更靈活地維護文件頁面（例如，您可以將匯出文件儲存在網頁根目錄之外的其他位置）。您不應在data-root屬性中新增尾部斜線。
請注意，設定此屬性不會影響頁面的圖示和徽標。它們仍將從index.html所在的相同目錄載入。
在 99.9% 的情況下，開啟index.html檔案將無法載入，因為這就是 fetch 的工作原理。要在本地預覽頁面，您可能需要使用 zeit/serve 等工具：
npx serve頁面將在 http://localhost:5000 處提供。
devhammed 製作了一個非常棒的 Insomnia 插件，它允許您直接從 Insomnia 的介面產生文件頁面。取得插件（npm - github）
請參閱變更日誌文件。
CLI 工具是一個指揮官小程序，而前端本身是一個 Svelte 應用程式。該專案仍處於測試階段，這意味著它存在錯誤並且可以到處改進。歡迎貢獻：）
克隆儲存庫：
git clone [email protected]:jozsefsallai/insomnia-documenter.git
cd insomnia-documenter安裝依賴項：
npm install複製示範 Insomnia 匯出檔案：
cp docs/insomnia.json public/insomnia.json透過熱重載運行開發建置：
npm run dev建立生產版本：
npm run build掉毛：
npm run lint測試：
npm run test 麻省理工學院。
注意：該項目與 Kong 和/或 Insomnia 無關。
作為 Tidelift 訂閱的一部分提供
Insomnia Documenter 和數千個其他軟體包的維護者正在與 Tidelift 合作，為您用於構建應用程式的開源依賴項提供商業支援和維護。節省時間、降低風險並改善程式碼運作狀況，同時向您使用的確切依賴項的維護者付費。了解更多。
