Insomnia API 客户端

Insomnia 是一个开源、跨平台的 API 客户端，支持 GraphQL、REST、WebSockets、服务器发送事件（SSE）、gRPC 和任何其他兼容 HTTP 的协议。

使用 Insomnia，您可以：

• 调试 API，使用最流行的协议和格式。
• 设计 API，使用原生 OpenAPI 编辑器和可视化预览。
• 测试 API，使用原生测试套件。
• 模拟 API，使用服务器和路由。
• 构建 CI/CD 流程，使用原生 Insomnia CLI 进行代码检查和测试。
• 与他人协作，使用多种协作功能分享您的项目。

还有更多功能！以下存储选项可用于您的项目、集合、规范和所有其他文件：

• 本地保管库：用于本地存储集合、设计规范和所有其他资源。
• 云同步：用于云端协作，加密且免费。
• Git 同步：使用任何第三方 Git 仓库存储所有文件。

开始使用

Insomnia 可用于 Mac、Windows 和 Linux，可以从以下网站下载：

https://insomnia.rest/download

账户与订阅

您可以使用草稿板功能而无需账户即可使用 Insomnia，或者免费创建账户以获得完整的产品功能。

即使有账户，Insomnia 也只会根据您选择的存储后端来存储您的项目和文件，可以是本地保管库、云同步、Git 同步或它们的任意组合。因此，您可以自由选择将敏感项目存储在本地，同时仍能在云端或 Git 上与他人协作。这是两全其美的选择。

高级功能和支持

Kong Inc. 提供商业订阅，可以多种方式增强 Insomnia 的功能。其中一些功能包括：为您的项目创建组织、使用 SAML 和 OIDC 的企业单点登录、在与他人共享项目时使用 RBAC、AI 功能以提高开发人员在创建、测试和文档化 API 时的生产力，以及更多功能。

您可以探索所有高级计划并免费开始使用。

错误和功能请求

遇到错误或有功能请求？首先，请阅读问题指南并搜索现有和已关闭的问题。如果您的问题或想法尚未得到解决，请提交新的问题。

对于更一般的产品问题和反馈，请加入Slack 团队。

贡献

请阅读我们的贡献指南和行为准则。其中包括提交问题、编码标准和开发说明。

文档

查看我们的开源 Insomnia 文档。

开发 Insomnia

只要您安装了 Node.js 和 Git，就可以在 Mac、Windows 或 Linux 上进行 Insomnia 的开发。请查看项目中的 .nvmrc 文件以获取正确的 Node 版本。

<details> <summary>初始开发设置</summary>

这个仓库采用 monorepo 结构，包含多个 Node.JS 包。每个包都有自己的一组命令，但最常用的命令可以在根目录的 package.json 中找到，并可以使用 npm run … 命令访问。以下是开始开发应用程序所需的三个主要命令。

# 安装和链接依赖项
npm i

# 运行代码检查
npm run lint

# 运行类型检查
npm run type-check

# 运行测试
npm test

# 启动应用程序并实时重载
npm run dev

Linux

如果您使用 Linux，可能需要安装以下支持包：

<details> <summary>Ubuntu/Debian</summary>

# 更新库
sudo apt-get update

# 安装字体配置库和支持
sudo apt-get install libfontconfig-dev

</details> <details> <summary>Fedora</summary>

# 安装 libcurl 用于 node-libcurl
sudo dnf install libcurl-devel

</details>

同样在 Linux 上，如果 Electron 在安装过程中失败，请运行以下命令：

# 清除 Electron 安装冲突
rm -rf ~/.cache/electron

Windows

如果您使用 Windows 并遇到问题，可能需要安装 Windows Build Tools。

</details> <details> <summary>编辑器要求</summary>

您可以使用任何您喜欢的编辑器，但请确保支持/安装了以下工具的插件：

• ESLint - 用于捕获语法问题和常见错误
• JSX 语法 - 用于 React 组件

</details>

开发 Inso CLI

• npm i
• 在监视模式下启动编译器：npm run inso-start
• 运行：./packages/insomnia-inso/bin/inso -v

插件

在 Insomnia 插件中心搜索、发现和安装插件！

社区项目

• Insomnia 文档生成器 - 使用 documenter 插件 或您的 Insomnia 导出文件生成漂亮的 API 文档页面。
• GitHub API 规范导入器 - 一组完整的 GitHub REST API 路由规范，可以直接导入到 Insomnia 中。
• Swaggymnia - 为您在 Insomnia 中现有的 API 生成 Swagger 文档。

许可证

Apache-2.0 © Insomnia