Kong/insomnia 来源：https://github.com/Kong/insomnia

Insomnia API 客户端

网站 (https://insomnia.rest) Stars Slack 频道 (https://chat.insomnia.rest/) 许可 Twitter 关注

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

• 调试 API —— 使用最流行的协议和格式。
• 设计 API —— 使用原生 OpenAPI 编辑器和可视化预览。
• 测试 API —— 使用原生测试套件和集合运行器。
• 模拟 API —— 使用云端或自托管模拟服务器。
• 构建 CI/CD 流水线 —— 使用原生的 Insomnia CLI 进行代码检查与测试。
• 与他人协作 —— 利用众多协作功能。
• 更多功能 —— 包括使用第三方插件的能力。

以下存储选项可用于你的 Insomnia 项目、集合、设计规范及其他所有资源：

• 本地保险库：100% 本地存储集合、设计规范及其他所有资源。
• Git 同步：通过任何第三方 Git 仓库进行 Git 存储，无需经过云端。
• 云同步：用于云端协作，可选端到端加密（E2EE）。

免费开始使用

Insomnia 支持 Mac、Windows 和 Linux，可从网站下载：https://insomnia.rest

账户与订阅

你可以不注册账户，使用本地的便签板来使用 Insomnia；也可以免费创建账户 (https://insomnia.rest/pricing) 以获取产品的全部功能。即使拥有账户，Insomnia 也仅会根据你选择的存储后端来存储项目和文件，存储后端可以是本地保险库、云同步、Git 同步或它们的任意组合。因此，举例来说，你可以自由选择将敏感项目 100% 存储在本地或 Git 仓库中，同时仍能在云端与他人协作其他项目。这是两全其美的方案。

为增强安全性，Insomnia 还提供私有环境功能，你的环境配置始终存储在本地，绝不存储到云端，与你为项目选择的存储选项无关。

高级功能与支持

Insomnia 拥有非常慷慨的免费计划，能满足大多数用户的需求。但如果你需要访问高级功能，比如无限制的协作、Git 同步、为项目创建组织、使用第三方身份提供商（SAML、OIDC）登录等，你可以探索其他订阅计划。你可以比较所有订阅计划 (https://insomnia.rest/pricing) 并免费开始使用。

为什么 Insomnia 需要账户？

如果你决定使用本地的便签板，则不需要账户。但要访问产品的绝大部分功能，我们需要你拥有一个账户。你的账户数据会按照 ISO27001、SOC 2 Type II、ISO27018、Gold CSA STAR 法规以及我们的服务条款和隐私政策进行安全存储。我们需要账户来可持续地构建和改进产品，并确保我们能够继续以免费开源形式提供众多核心功能。虽然开源软件可以免费使用，但构建它并不免费。我们能否继续开发 Insomnia，取决于我们能否将一部分需要高级功能的免费用户转化为付费客户。

如果你是一位无法将 API 数据（如集合和设计规范）共享到云端的用户，你仍然可以通过将 Insomnia 项目的存储选择为“本地保险库”来实现：拥有 Insomnia 账户并不限制你如何存储敏感的 API 数据（你可以通过本地保险库 100% 本地存储，通过 Git 同步存储到第三方 Git 仓库而不经过云端，或通过云同步存储在云端以便于协作）。

Bug 报告与功能请求

发现 Bug 或想提出功能请求？请先阅读问题指南并搜索已有和已关闭的问题。如果问题或想法尚未被提及，请新建一个 Issue (https://github.com/Kong/insomnia/issues)。更通用的产品问题和反馈，请加入 Slack 团队 (https://chat.insomnia.rest)。

贡献

请阅读我们的贡献指南和行为准则。其中包含了提交 Issue 的指引、编码规范以及开发说明。

文档

查看我们的官方 Insomnia 文档 (https://docs.insomnia.rest/)。

开发 Insomnia

只要具备 Node.js (https://nodejs.org) 和 Git (https://git-scm.com/)，就可在 Mac、Windows 或 Linux 上进行 Insomnia 的开发。请参考项目中的 .nvmrc 文件以获取正确的 Node 版本。

初始开发环境设置

本仓库是一个 monorepo，包含多个 Node.js 包。每个包都有自己的命令集，但最常用的命令可以从根目录的 package.json 中找到，并使用 npm run ... 命令执行。以下是开发应用所需要知道的三条命令。

# 安装并链接依赖
npm i

# 运行代码检查
npm run lint

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

# 运行测试
npm test

# 启动应用并启用热重载
npm run dev

# 启动应用，同时启用渲染进程热重载和主进程自动重启
npm run dev:autoRestart

Linux

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

Ubuntu/Debian

# 更新库
sudo apt-get update

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

Fedora

# 安装 node-libcurl 所需的 libcurl
sudo dnf install libcurl-devel

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

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

Windows

如果你使用 Windows 并遇到问题，可能需要安装 Windows Build Tools (https://github.com/felixrieseberg/windows-build-tools)

编辑器要求

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

• ESLint (http://eslint.org/)：用于捕捉语法问题和常见错误
• JSX 语法 (https://facebook.github.io/react/docs/jsx-in-depth.html)：用于 React 组件

开发 Inso CLI

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

插件

在 Insomnia 插件中心 (https://insomnia.rest/plugins/) 搜索、发现并安装插件！

社区项目

• Insomnia Documenter (https://github.com/jozsefsallai/insomnia-documenter) —— 使用 documenter 插件 (https://insomnia.rest/plugins/insomnia-plugin-documenter) 或 Insomnia 导出文件生成漂亮的 API 文档页面。
• GitHub API Spec Importer (https://github.com/swinton/github-rest-apis-for-insomnia) —— 一套完整的 GitHub REST API 路由规范，可直接导入到 Insomnia。
• Swaggymnia (https://github.com/mlabouardy/swaggymnia) —— 为 Insomnia 中现有的 API 生成 Swagger (https://swagger.io/) 文档。

许可证

Apache-2.0 © Insomnia (https://insomnia.rest)