失眠

失眠 API 客户端

Insomnia 是一个开源、跨平台 API 客户端，适用于 GraphQL、REST、WebSockets、服务器发送事件 (SSE)、gRPC 和任何其他 HTTP 兼容协议。

对于失眠，您可以：

• 使用最流行的协议和格式调试 API 。

• 使用本机 OpenAPI 编辑器和可视化预览设计 API 。

• 使用本机测试套件和集合运行器测试 API 。

• 使用云或自托管模拟服务器模拟 API 。

• 使用本机 Insomnia CLI构建 CI/CD 管道进行 linting 和测试。

• 使用许多协作功能与其他人协作。

• 更多包括使用第三方插件的能力。

您的 Insomnia 项目、集合、设计规范和所有其他资源支持以下存储选项：

• 本地保管库：100% 本地存储馆藏、设计规范和所有其他资源。

• Git Sync ：使用任何第 3 方 Git 存储库进行 Git 存储，无需通过云。

• 云同步：用于云协作，可选择在云中进行端到端加密 (E2EE)。

免费开始使用

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

https://insomnia.rest

帐户和订阅

您可以在没有帐户的情况下通过本地Scratch Pad使用 Insomnia，也可以免费创建一个帐户来访问该产品的全部功能。

即使拥有帐户，Insomnia 也只会根据您选择的存储后端来存储您的项目和文件，该存储后端可以是本地 Vault、云同步、Git 同步或它们的任意组合。因此，例如，您可以自由选择将敏感项目 100% 存储在本地或 Git 存储库中，同时仍然能够在云中与其他项目进行协作。这是两全其美的。

为了增加安全性，Insomnia 还提供了私有环境功能，您的环境配置始终存储在本地，而不是存储在云中，独立于您为项目选择的存储选项。

高级功能和支持

Insomnia 有一个非常慷慨的免费计划，可以满足大多数用户的需求，但如果您需要访问高级功能，例如无限协作、Git 同步功能、为您的项目创建组织的能力、使用第三方 IDP 登录（SAML、OIDC）和许多其他功能，然后您可以探索其他订阅计划。

您可以比较所有订阅计划并免费开始。

为什么 Insomnia 需要一个帐户？

如果您决定使用本地Scratch Pad ，Insomnia 不需要帐户，但要访问该产品的大部分功能，我们需要一个帐户。您的帐户数据将按照 ISO27001、SOC 2 Type II、ISO27018、Gold CSA STAR 法规以及我们的服务条款和隐私政策进行安全存储。

我们需要一个帐户来可持续地构建和改进产品，并确保我们能够继续在免费和开源发行版中提供许多核心功能。虽然开源软件可以免费使用，但不幸的是它不是免费构建的，我们继续致力于 Insomnia 的能力取决于我们将一部分免费用户（需要高级功能）转变为我们产品的付费客户的能力。

如果您是无法将集合和设计规范等 API 数据共享到云端的用户，仍然可以通过选择“本地保管库”作为 Insomnia 项目的存储来实现：拥有 Insomnia 帐户与您希望的存储方式无关您的敏感 API 数据（可以通过 Local Vault 100% 本地存储、通过 Git Sync 存储在没有任何云存储的第 3 方 Git 存储库上，或者通过 Cloud Sync 存储在云中以便于协作）。

错误和功能请求

有错误或功能请求吗？首先，阅读问题指南并搜索现有和已解决的问题。如果您的问题或想法尚未得到解决，请打开一个新问题。

有关更多通用产品问题和反馈，请加入 Slack 团队。

贡献

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

文档

查看我们的官方失眠文档。

出现失眠

只要您有 Node.js 和 Git，就可以在 Mac、Windows 或 Linux 上完成 Insomnia 的开发。请参阅项目中的.nvmrc文件以获取正确的 Node 版本。

初始开发设置

该存储库的结构为 monorepo，包含许多 Node.JS 包。每个包都有自己的命令集，但最常用的命令可从根package.json中获取，并且可以使用npm run …命令进行访问。以下是开始在应用程序上进行开发所需的唯一三个命令。

 # 安装并链接依赖项npm i# 运行 Lintnpm run lint# 运行类型检查npm run type-check# 运行测试snpm test# 通过实时重新加载启动应用程序npm run dev

Linux

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

Ubuntu/Debian

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

软呢帽

# 为 node-libcurlsudo dnf install libcurl-devel 安装 libcurl

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

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

视窗

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

编辑要求

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

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

• JSX 语法 - 对于 React 组件

开发 Inso CLI

• npm i

• 以监视模式启动编译器： npm run inso-start

• 运行： ./packages/insomnia-inso/bin/inso -v

插件

从 Insomnia 插件中心搜索、发现并安装插件！

社区项目

• Insomnia Documenter - 使用文档插件或 Insomnia 导出文件生成漂亮的 API 文档页面。

• GitHub API Spec Importer - 一套完整的 GitHub REST API 路由规范，可以直接导入到 Insomnia 中。

• Swaggymnia - 为 Insomnia 中现有的 API 生成 Swagger 文档.

执照

Apache-2.0 © 失眠