Hoppscotch 安装教程:5 分钟装好开源 API 调试工具
【免费下载链接】hoppscotchOpen-Source API Development Ecosystem • https://hoppscotch.io • Offline, On-Prem & Cloud • Web, Desktop & CLI • Open-Source Alternative to Postman, Insomnia项目地址: https://gitcode.com/GitHub_Trending/ho/hoppscotch
Hoppscotch 是一个开源 API 开发生态,覆盖 REST、GraphQL、WebSocket 等请求的调试与协作。这是一份实操向的 Hoppscotch 安装教程:从源码到本地跑通只需要三条命令,装完你直接得到一个能发请求、组织集合、管理环境变量的界面,Web 和桌面两种形态都能用。
📋 装前自检
动手前先对照下面的清单确认环境。这个仓库是个 monorepo,packages/ 下同时放着前端、后端、CLI、桌面端等多个子包,所以磁盘占用比普通单应用项目高一些。
| 项目 | 要求 | 说明 |
|---|---|---|
| Node.js | 18 及以上,推荐 LTS | 前端构建走 Vite 7,对 Node 版本有下限 |
| pnpm | 10.x | 仓库 package.json 锁定了 pnpm@10.33.4 |
| Git | 任意较新版本 | 拉取代码用 |
| 磁盘 | 至少 4GB 空闲 | 主要消耗在 node_modules |
| 内存 | 建议 4GB 以上 | 并行编译多个子包时更从容 |
如果你机器上还没有 pnpm,先补上这一步:
npm install -g pnpm装完可以用pnpm -v确认输出了 10 开头的版本号。
🚀 三步装好它
1️⃣ 拉代码
git clone https://gitcode.com/GitHub_Trending/ho/hoppscotch cd hoppscotch执行完,当前目录会出现 hoppscotch,根目录有 package.json、docker-compose.yml 和 packages/ 子包。
2️⃣ 装依赖
pnpm install预期结果:首次安装大约 3–5 分钟。注意 common 和 selfhost-web 两个包在 postinstall 里会自动跑 GraphQL 代码生成,所以依赖装完还会多停留一会儿,属于正常现象,不是卡死。
3️⃣ 起服务
pnpm dev预期结果:命令会并行拉起各应用自己的开发服务,终端里能看到 Vite 的编译输出。Web 界面默认跑在 http://localhost:3000,地址以终端实际打印为准。
✅ 装完怎么算成功
两个肉眼可见的信号,都满足就是装好了:
- 浏览器打开 http://localhost:3000,能看到主界面:左侧请求侧栏,中间是 URL 输入框和方法下拉。
- 在 URL 里填一个公开 API 地址,选 GET,点发送,右侧出现状态码 200 和响应体。
如果页面能打开但发请求报错,多半是网络或 CORS 问题,和部署本身无关,不必怀疑装坏了。
🧰 能力速览
装好之后这些能力开箱即用,不需要额外配置:
- ✅ REST 请求:GET / POST / PUT / PATCH / DELETE 全支持,也允许手输 LIST 这类自定义方法
- ✅ GraphQL 调试:拉取 schema、查询补全、多栏文档视图
- ✅ WebSocket、Socket.IO、MQTT、SSE 四种实时通信调试
- ✅ 认证方式:Basic、Bearer Token、OAuth 2.0、OIDC Access Token
- ✅ 环境变量:请求和脚本里共享复用,一处改值处处生效
- ✅ 集合与文件夹:请求归档组织,一键重放
- ✅ Pre-Request 脚本与 Post-Request 测试:发前改值、收后断言
- ✅ PWA:可安装到桌面,离线状态下照常使用
🚧 避坑手册
npm install 直接被拒仓库的 preinstall 脚本写死了只允许 pnpm,用 npm 或 yarn 装依赖会当场报错。换回 pnpm install 就行。
3000 端口被占用Vite 检测到占用会切到下一个可用端口,直接用终端新打印的地址访问;嫌麻烦就杀掉占用 3000 的进程后重跑 pnpm dev。
首次安装特别慢或中途报错依赖树大,还叠加了两处 postinstall 代码生成,首次慢是常态。报错的话删掉 node_modules 重新 pnpm install,网络不稳时先切国内镜像源。
🧭 下一步
想在命令行跑测试的话,看 packages/hoppscotch-cli 这个子包,它是官方 CLI,支持加载整个集合批量执行并输出结果。想要原生桌面客户端,对应 packages/hoppscotch-desktop,可以连接自托管实例本地运行。需要完整自托管(后端、管理面板、前端一起上)时,从仓库根目录的 docker-compose.yml 入手,配合 hoppscotch-backend 和 hoppscotch-sh-admin 两个子包。
想读源码的话,前端主体集中在 packages/hoppscotch-common 目录,请求、集合、环境这些核心逻辑都从那里展开。
【免费下载链接】hoppscotchOpen-Source API Development Ecosystem • https://hoppscotch.io • Offline, On-Prem & Cloud • Web, Desktop & CLI • Open-Source Alternative to Postman, Insomnia项目地址: https://gitcode.com/GitHub_Trending/ho/hoppscotch
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考