insomnia documenter

就像邮差记录员，但针对失眠！借助此工具，您可以使用 Insomnia 导出文件生成漂亮的 API 文档页面。

演示：https://insodoc.github.io/insomnia-documenter/
教程和演示视频：https://www.youtube.com/watch?v=pq2u3FqVVy8

目录

• 目录
• 要求
• 入门
  • 使用npx
  • 通过全局安装包
  • 选项
  • 使用 GitHub 版本
• 更新API
• 自定义根路径
• 本地运行页面
• 失眠插件
• 变更日志
• 贡献
• 执照
• 企业失眠记录仪

要求

• Node.js（建议8.x或更高版本）
• 导出的 Insomnia 工作区 JSON (v4)

入门

Insomnia Documenter 提供了一个 CLI 工具，可以非常轻松地设置文档页面。您可以通过两种方式使用它。

使用npx

npx insomnia-documenter --config /path/to/insomnia/config.json

通过全局安装包

npm 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 版本

或者，您可以通过从 GitHub 下载发布存档并将insomnia.json导出文件添加到站点的根目录来开始使用 Insomnia Documenter。

更新API

更新 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 合作，为您用于构建应用程序的开源依赖项提供商业支持和维护。节省时间、降低风险并改善代码运行状况，同时向您使用的确切依赖项的维护者付费。了解更多。