如何快速上手 Hoppscotch:开源 API 调试与构建工具完整指南
发布时间:2026/9/19 12:27:13 锦皓数字建站

如何快速上手 Hoppscotch开源 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/hoppscotchHoppscotch 是一个开源 API 开发生态系统覆盖 Web、桌面和 CLI 三种形态帮你在一个界面里完成请求构建、调试、测试与团队协作。它是 Postman 和 Insomnia 的开源替代方案支持 REST、GraphQL、WebSocket、SSE、Socket.IO、MQTT 等多种协议。项目前身叫 Postwoman现已正式更名为 Hoppscotch仓库地址为 https://gitcode.com/GitHub_Trending/ho/hoppscotch 采用 MIT 协议可离线、可私有化部署、也可使用云服务。环境要求依赖版本一览依赖版本说明Node.js≥22CLI 包 声明的最低引擎版本pnpm10.33.4根package.json通过packageManager锁定并有preinstall脚本禁止使用其他包管理器PostgreSQL15自托管后端使用的数据库Docker 部署时自动拉起3 步跑起开发环境克隆仓库git clone https://gitcode.com/GitHub_Trending/ho/hoppscotch.git进入根目录安装依赖postinstall钩子会自动执行 GraphQL 代码生成和 Prisma Client 生成cd hoppscotch pnpm install启动开发服务。根目录的dev脚本会并行拉起各工作区包的 Vite 开发服务器pnpm dev只想跑自托管前端时可单独进入 packages/hoppscotch-selfhost-web 执行pnpm do-dev它会并行运行 Vite 和 GraphQL codegen 的 watch 模式。Docker 一键部署方法仓库内置了按 profile 划分的 docker-compose.yml。推荐用默认 profile 一键起全部服务AIO 应用 Postgres 自动迁移docker compose --profile default up启动后 Web 端在 3000 端口、自托管管理面板在 3100 端口。也提供了backend、app、admin、just-backend等 profile 用于单独起某个组件。仓库地图关键目录速览路径一句话作用建议阅读顺序packages/hoppscotch-common/应用主体Vue 3 界面、请求/响应/集合/环境的核心逻辑1packages/hoppscotch-selfhost-web/自托管版前端入口含 Go 编写的 webapp-server2packages/hoppscotch-backend/NestJS Prisma 后端提供 GraphQL API 与团队协作能力3packages/hoppscotch-cli/命令行工具hopp用于在 CI 中跑测试脚本4packages/hoppscotch-desktop/基于 Tauri 的桌面应用封装5docker-compose.yml / prod.Dockerfile一键部署编排与多阶段生产镜像构建6pnpm-workspace.yaml声明packages/**为工作区统一管理子包7其余如LICENSE、CODE_OF_CONDUCT.md、[CONTRIBUTING.md](https://link.gitcode.com/i/2a58d087b02bfe0e26d2a1bff0271503)、TRANSLATIONS.md属于社区规范与国际化流程文件快速扫一遍即可。配置在哪环境变量与工程配置环境变量自托管服务统一从根目录.env文件读取compose 中通过env_file注入核心变量是DATABASE_URL前端 GraphQL codegen 也通过dotenv_config_path指向同一份.env。工作区配置pnpm-workspace.yaml 圈定子包范围并设置了minimumReleaseAge依赖新鲜度保护根package.json里的pnpm.overrides统一锁定了一批存在漏洞的传递依赖版本。代码风格与提交规范各子包自带eslint.config.*与 Prettier 配置根目录还有 commitlint.config.js 配合 Husky 强制 Conventional Commits 提交格式lint、typecheck、test等脚本均可在根目录用pnpm -r一键贯穿所有子包。下一步读源码与常用命令速查从 hoppscotch-common/src/pages/ 的 HTTP 请求页入手看请求如何流经helpers/下的 auth、request、response 模块。想理解后端同步机制沿 hoppscotch-backend/src/ 的 team、team-collection 等 resolver 读起数据模型见prisma/schema.prisma。对 CI 场景感兴趣的话读 hoppscotch-cli/src/commands/test.ts 和src/__tests__/里的端到端用例。想扩展数据模型类型参考 hoppscotch-data/ 的 io-ts 类型定义它是 common 与 cli 共享的数据契约。常用命令速查命令作用pnpm dev并行启动所有子包开发服务pnpm generate构建全部生产产物pnpm start用 http-server 预览 selfhost-web 构建产物3000 端口pnpm lint/pnpm typecheck/pnpm test全工作区检查与测试【免费下载链接】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),仅供参考
锦
锦皓数字建站
深耕本土企业品牌数字化升级,专注原创端正雅致商务官网,从视觉设计到稳定运维全程保驾护航。