Hoppscotch

Hoppscotch

开源 API 开发生态系统

由贡献者 用❤︎建造

支持

特征

❤️ 轻量级： 采用简约的 UI 设计精制而成。

⚡️ 快速： 实时发送请求和获取/复制响应。

HTTP 方法

• GET- 请求检索资源信息
• POST- 服务器在数据库中创建一个新条目
• PUT- 更新现有资源
• PATCH- 非常类似于 PUT但对资源进行部分更新
• DELETE- 删除资源或相关组件
• HEAD- 检索与 GET 请求相同的响应标头，但没有响应正文。
• CONNECT- 建立到目标资源标识的服务器的隧道
• OPTIONS- 描述目标资源的通信选项
• TRACE- 沿着到目标资源的路径执行消息环回测试
• <custom>- 一些 API 使用自定义请求方法，例如 LIST. 输入您的自定义方法。

🌈 让它成为你 的：背景色、前景色和强调色的可定制组合——立即定制。

主题化

• 选择主题：系统（默认）、浅色、深色和黑色
• 选择强调色：绿色（默认）、蓝绿色、蓝色、靛蓝、紫色、黄色、橙色、红色和粉色
• 无干扰的禅宗模式

自定义主题与云/本地会话同步

🔥 PWA： 在您的设备上安装为PWA 。

• 使用 Service Worker 即时加载
• 离线支持
• 低 RAM/内存和 CPU 使用率
• 添加到主屏幕
• 桌面 PWA

🚀 请求： 立即从端点检索响应。

1. 选择 method
2. 进入 URL
3. 发送

• 复制/共享公共“共享 URL”
• 为 10 多种语言和框架生成/复制请求代码片段
• 进口 cURL
• 标签请求

🔌 WebSocket： 通过单个 TCP 连接建立全双工通信通道。

📡 服务器发送的事件： 通过 HTTP 连接从服务器接收更新流，而不诉诸轮询。

🌩 Socket.IO： 使用 SocketIO 服务器发送和接收数据。

🦟 MQTT： 订阅和发布到 MQTT 代理的主题。

🔮 GraphQL： GraphQL 是一种用于 API 的查询语言，也是一种使用现有数据完成这些查询的运行时。

• 设置端点并获取架构
• 多栏文档
• 设置自定义请求标头
• 查询架构
• 获取查询响应

🔐 授权： 允许识别最终用户。

• 没有任何
• 基本的
• 不记名令牌
• OAuth 2.0
• OIDC 访问令牌/PKCE

📢 标头： 描述发送请求正文的格式。

📫 参数： 使用请求参数来设置模拟请求中的不同部分。

📃 请求正文： 用于通过 REST API 发送和接收数据。

• 放 Content Type
• FormData、JSON 等
• 在键值和 RAW 输入参数列表之间切换

👋 响应： 包含状态行、标题和消息/响应正文。

• 将响应复制到剪贴板
• 将响应下载为文件
• 查看响应标头
• 查看 HTML、图像、JSON、XML 响应的原始和预览

⏰ 历史记录： 请求条目与云/本地会话存储同步，只需单击即可恢复。

📁 集合： 使用集合和文件夹组织您的 API 请求。只需单击一下即可重复使用它们。

• 无限的收藏、文件夹和请求
• 嵌套文件夹
• 作为文件或 GitHub gist 导出和导入

集合与云/本地会话存储同步

🌐 代理： 从设置中启用代理模式以访问被阻止的 API。

• 隐藏您的 IP 地址
• 修复CORS（跨域资源共享）问题
• 访问在非 HTTPS ( http://) 端点中提供的 API
• 使用您的代理 URL

官方代理服务器由 Hoppscotch 托管 - GitHub -隐私政策

📜 Pre-Request Scripts β： 与在发送请求之前执行的请求相关联的代码片段。

• 设置环境变量
• 在请求标头中包含时间戳
• 在 URL 参数中发送随机字母数字字符串
• 任何 JavaScript 函数

📄 API 文档： 轻松、快速地创建和共享动态 API 文档。

1. 将您的请求添加到集合和文件夹
2. 导出集合并轻松与团队其他成员共享您的 API
3. 随时随地导入集合并生成文档

⌨️ 键盘快捷键： 针对效率进行了优化。

阅读我们关于键盘快捷键的文档

🌎 i18n： 以您的语言体验应用程序。

帮助我们翻译 Hoppscotch。请阅读TRANSLATIONS我们的详细信息CODE OF CONDUCT，以及向我们提交拉取请求的过程。

📦 附加组件： hoppscotch 的官方附加组件。

• 代理 - 为 Hoppscotch 创建的简单代理服务器
• CLI β - Hoppscotch 的 CLI 解决方案
• 浏览器扩展 - 简化访问 Hoppscotch 的浏览器扩展 火狐 | 铬合金

  扩展修复 CORS问题。

• Hopp-Doc-Gen - 用于 Hoppscotch 的 API 文档生成器 CLI

附加组件是在Hoppscotch 组织下开发和维护的。

☁️ Auth + Sync： 登录并实时同步您的数据。

登陆使用

• GitHub
• 谷歌
• 微软
• 电子邮件

同步您的数据

• 历史
• 收藏品
• 环境
• 设置

✅ 请求后测试 β： 编写与请求相关的测试，在请求响应后执行。

• 检查状态码为整数
• 过滤响应标头
• 解析响应数据
• 设置环境变量
• 编写 JavaScript 代码

🌱 环境 ：环境变量允许您在请求和脚本中存储和重用值。

• 无限的环境和变量
• 通过预请求脚本初始化
• 导出为/从 GitHub gist 导入

👨‍👩‍👧‍👦 Teams β： 帮助您跨团队协作以更快地设计、开发和测试 API。

• 无限团队
• 无限共享收藏
• 无限的团队成员
• 基于角色的访问控制
• 云同步
• 多台设备

🚚 批量编辑：批量编辑键值对。

• 条目由换行符分隔
• 键和值由 :
• 预先 #添加到您要添加但保持禁用的任何行

有关更多功能，请阅读我们的文档。

演示

hoppscotch.io

用法

1. 在 URL 字段中提供您的 API 端点
2. 点击“发送”模拟请求
3. 查看响应

内置

• HTML
• CSS , SCSS ,windi CSS
• JavaScript
• typescrip
• Vue
• nuxtjs

发展

0. 使用您自己的密钥更新.env.example找到的文件 packages/hoppscotch-app并将其重命名为 .env.

示例密钥仅适用于生产版本。

基于浏览器的开发环境

• GitHub 代码空间
• Gitpod

本地开发环境

1. 用 git克隆这个 repo 。
2. 通过运行使用 npm 安装 pnpm npm install -g pnpm。
3. pnpm install通过在您克隆的目录（可能 hoppscotch）中运行来安装依赖项。
4. 用 . 启动开发服务器 pnpm run dev。
5. http://localhost:3000在浏览器中打开开发站点。

Docker撰写

1. 用 git克隆这个 repo 。
2. 在您克隆的目录中运行 docker-compose up（可能 hoppscotch）。
3. http://localhost:3000在浏览器中打开开发站点。

Dokcer

镜像

docker run --rm --name hoppscotch -p 3000:3000 hoppscotch/hoppscotch:latest

释放

1. 用 git克隆这个 repo 。
2. 通过运行使用 npm 安装 pnpm npm install -g pnpm。
3. pnpm install通过在您克隆的目录（可能 hoppscotch）中运行来安装依赖项。
4. 使用您自己的密钥更新.env.example找到的文件 packages/hoppscotch-app并将其重命名为 .env.
5. 使用 pnpm run generate.
6. 在 中找到构建的项目 packages/hoppscotch-app/dist。在任何静态托管服务器上托管这些文件。

贡献

请使用GitHub Flow进行贡献。创建一个分支，添加提交，然后打开一个拉取请求。

请阅读CONTRIBUTING我们的详细信息CODE OF CONDUCT，以及向我们提交拉取请求的过程。

持续集成

我们使用GitHub Actions进行持续集成。查看我们的构建工作流程。

变更日志

有关详细信息，请参阅CHANGELOG文件。

作者

这个项目的存在要感谢所有贡献的人——贡献。

执照

该项目在MIT 许可下获得许可- 详情请参阅LICENSE文件。