wehub/hoppscotch--hoppscotch
1
0
Fork 0
Code Issues Pull Requests Actions Deployments Models Agent Notes Packages Projects Releases Wiki Activity
Files
main
hoppscotch--hoppscotch/README.md
T
wehub-resource-sync 4efb405cda
Node.js CI / Test (22) (push) Has been cancelled
Details
docs: make Chinese README the default
2026-07-13 09:50:32 +00:00

11 KiB
Raw Permalink Blame History

Note

本文档由 WeHub 基于上游 README 翻译整理，属于社区翻译，非官方中文文档。
English · 原始项目 · 上游 README
原作者、版权与许可证归属以原始项目及本仓库 LICENSE 文件为准。

Hoppscotch

Hoppscotch

开源 API 开发生态系统

contributions welcome Website Tests Tweet

由 contributors 用 ❤︎ 构建


Hoppscotch

我们强烈建议你阅读 Hoppscotch 文档，以进一步了解该应用。

支持

Chat on Discord Chat on Telegram Discuss on GitHub

功能特性

❤️ 轻量： 采用极简 UI 设计精心打造。

⚡️ 快速： 实时发送请求并获取响应。

🗄️ HTTP 方法： 请求方法定义了你要执行的操作类型。

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

🌈 主题： 可自定义背景、前景和强调色的组合 — 立即自定义.

  • 选择主题：系统偏好、浅色、深色和黑色
  • 选择强调色：绿色、青绿、蓝色、靛蓝、紫色、黄色、橙色、红色和粉色
  • 无干扰禅模式

自定义主题会与你的云端/本地会话同步。

🔥 PWA： 在你的设备上安装为 渐进式 Web 应用（Progressive Web App）。

  • 通过 Service Workers 实现即时加载
  • 离线支持
  • 低 RAM/内存和 CPU 占用
  • 添加到主屏幕
  • 桌面端 PWA

🚀 请求： 即时从端点获取响应。

  1. 选择 method
  2. 输入 URL
  3. 发送
  • 复制/分享公开的「Share URL」
  • 为 10+ 种语言和框架生成/复制请求代码片段
  • 导入 cURL
  • 为请求添加标签

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

📡 服务器发送事件（Server-Sent Events）： 通过 HTTP 连接接收来自服务器的更新流，无需轮询。

🌩 Socket.IO： 与 SocketIO 服务器收发数据。

🦟 MQTT： 订阅和发布 MQTT Broker 的主题。

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

  • 设置端点并获取 schema
  • 多列文档
  • 设置自定义请求头
  • 查询 schema
  • 获取查询响应

🔐 授权： 用于识别最终用户。

  • None
  • Basic
  • Bearer Token
  • OAuth 2.0
  • OIDC Access Token/PKCE

📢 请求头： 描述请求体的发送格式。

📫 参数： 使用请求参数在模拟请求中设置可变部分。

📃 请求体： 用于通过 REST API 收发数据。

  • 设置 Content Type
  • FormData、JSON 等多种格式
  • 在键值对和 RAW 输入参数列表之间切换

📮 响应： 包含状态行、请求头和消息/响应体。

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

⏰ 历史记录： 请求条目会与你的云端/本地会话存储同步。

📁 集合： 通过集合和文件夹整理 API 请求，一键复用。

  • 不限数量的集合、文件夹和请求
  • 嵌套文件夹
  • 以文件或 GitHub gist 形式导出和导入

集合会与你的云端/本地会话存储同步。

📜 预请求脚本： 与请求关联的代码片段，在请求发送前执行。

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

👨‍👩‍👧‍👦 团队： 帮助你在团队间协作，更快设计、开发和测试 API。

  • 创建不限数量的团队
  • 创建不限数量的共享集合
  • 创建不限数量的团队成员
  • 基于角色的访问控制
  • 云端同步
  • 多设备

👥 工作区： 将个人和团队的集合环境组织到工作区中，轻松切换工作区以管理多个项目。

  • 创建不限数量的工作区
  • 在个人和团队工作区之间切换

⌨️ 键盘快捷键： 为高效操作而优化。

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

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

  • 隐藏你的 IP 地址
  • 修复 CORS（跨源资源共享，Cross-Origin Resource Sharing）问题
  • 访问通过非 HTTPS（http://）端点提供的 API
  • 使用你的代理 URL

官方代理服务器由 Hoppscotch 托管 - GitHub - 隐私政策（Privacy Policy）.

🌎 国际化（i18n）： 用你的语言体验应用。

帮助我们翻译 Hoppscotch。请阅读 TRANSLATIONS 了解我们的 CODE OF CONDUCT 以及向我们提交拉取请求的流程。

☁️ 认证 + 同步： 登录并在所有设备上实时同步你的数据。

登录方式：

  • GitHub
  • Google
  • Microsoft
  • Email
  • SSO（单点登录，Single Sign-On）1

🔄 同步你的数据： 接力在其他设备上继续任务。

  • 工作区
  • 历史记录
  • 集合
  • 环境
  • 设置

✅ 请求后测试： 编写与请求关联的测试，在收到响应后执行。

  • 将状态码作为整数检查
  • 筛选响应头
  • 解析响应数据
  • 设置环境变量
  • 编写 JavaScript 代码

🌱 环境： 环境变量让你能在请求和脚本中存储并复用值。

  • 不限数量的环境和变量
  • 通过预请求脚本初始化
  • 导出为 / 从 GitHub gist 导入
使用场景
  • 将值存入变量后，可在请求部分的任意位置引用该变量
  • 如需更新值，只需修改一处
  • 使用变量能提升工作效率，并最大限度降低出错概率

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

  • 条目之间以换行分隔
  • 键和值之间以 : 分隔
  • 在要添加但保持禁用的行前加上 #

🎛️ 管理面板： 管理团队和邀请成员。

  • 数据洞察
  • 用户管理
  • 团队管理

📦 附加组件： Hoppscotch 官方附加组件。

附加组件由 Hoppscotch 组织.)** 开发和维护。_

完整功能列表请阅读我们的文档.)。**

演示

使用方法

  1. 在 URL 字段中输入你的 API 端点
  2. 点击"发送"模拟请求
  3. 查看响应

开发

请参考我们的自托管文档)来搭建开发环境。

贡献

请使用 GitHub Flow.) 进行贡献。创建一个分支，提交代码，然后发起拉取请求.)。

请阅读 CONTRIBUTING 了解我们的 CODE OF CONDUCT 以及提交拉取请求的流程。

持续集成

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

更新日志

详情请参见 CHANGELOG 文件。

作者

本项目的存在离不开所有贡献者的共同努力——立即贡献。

许可证

本项目基于 MIT 许可证) 授权——详见 LICENSE 文件。

注意： 免费版 API 不包含企业版功能。

  1. 企业版功能。了解更多.) USD 预算：$0/$3；剩余 $3；已支出 $0；未使用 $0。 ↩︎

Reference in New Issue View Git Blame Copy Permalink