Hoppscotch API 测试完整指南
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 开发生态一个工具里同时覆盖 REST、GraphQL、WebSocket、SSEServer-Sent Events即服务器主动推送事件给浏览器的协议等常用协议并内置环境变量、预请求脚本与团队协作能力。无论你是想在浏览器里快速验证一个接口还是想在内网自建一套团队服务抑或是装成桌面应用离线使用它都提供了对应的路径。下面从发送第一个请求讲起一直覆盖到自托管部署和团队落地。 3 步发出你的第一个 GET 请求打开 Hoppscotch 后你直接落在 REST 请求界面无需注册和配置。实际操作就三步选方法下拉框里选GET也可以直接敲入LIST这类自定义方法填地址输入https://echo.hoppscotch.io这是官方回显服务器会把你的请求原样返回适合练手发请求点击Send响应区即时显示状态码、耗时和响应体地址栏上方那个环境选择器值得留意它是多环境配置的入口稍后会展开讲。左侧边栏是集成的集合树你可以按项目把请求归档成文件夹并支持导入导出。拿到别人给的 cURL 命令时直接粘贴导入即可不用逐个参数手工搬。 接口换环境一键切换基础地址联调时你大概率会碰到这种情况开发、测试、生产三套环境接口一样、域名不同手动逐个改地址又慢又容易漏。环境变量就是为这个设计的。在右上角环境选择器里新建一个名为dev的环境定义变量baseUrl https://dev-api.example.com然后请求地址栏写{{baseUrl}}/users双花括号表示引用变量。之后切到prod环境同一批请求自动指向生产地址零改动。变量的存储与替换逻辑位于packages/hoppscotch-common/src/newstore/environments.ts想弄清变量在请求里如何被解析可以从这个文件入手。 3 步配好 Bearer Token 认证现代 API 大多用 Token 鉴权。在请求视图点开Authorization标签页会看到 Basic、Bearer Token、OAuth 2.0、OIDC 等类型可选。以最常见的 Bearer 为例认证类型选Bearer Token把 Token 粘贴进输入框也可以写{{apiToken}}让环境变量接管凭证发送请求工具会自动拼好Authorization: Bearer ...请求头同一个 Token 可被多个请求复用不必每次手写请求头。如果接口走 OAuth 2.0 的客户端凭证或 PKCE 流程也支持配置后由工具自动完成换令牌相关实现集中在packages/hoppscotch-common/src/components/auth/。️ 内网自托管部署一条命令跑起来公司有数据安全要求、不想依赖外部服务时Hoppscotch 支持完整的本地部署。仓库里直接带了现成的docker-compose.yml应用、后端、PostgreSQL 数据库一应俱全还内置了自动迁移服务。先克隆仓库git clone https://gitcode.com/GitHub_Trending/ho/hoppscotch再启动默认部署含数据库与自动迁移docker compose --profile default up启动后应用访问 3000 端口、管理面板 3100 端口、API 服务 3170 端口。桌面应用还能连上你的自建实例在左上角下拉菜单里添加入口填上自托管地址请求和集合就都落在你自己的后端里。如果想从源码跑起来pnpm install之后执行pnpm dev即可进入开发模式。整个仓库是 pnpm monorepo前端在hoppscotch-common后端在hoppscotch-backendCLI 在hoppscotch-cli。 不止 RESTGraphQL 与 WebSocket 同样开箱即用用惯 REST 之后看看左侧边栏的其他协议图标每个图标对应一类协议入口GraphQL填入 endpoint 后自动拉取 schema左边文档面板、右边查询编辑器WebSocket / Socket.IO / MQTT全双工实时通道发送、订阅、消息流一览无余SSE测试服务器推送类接口不用自己写轮询代码同一套环境变量和集合在所有协议下通用切协议不必换工具。桌面端对文件上传类接口也很友好form-data 表单里直接选本地文件即可 团队使用把测试用例变成 CI 里的代码个人使用以请求攒进集合为主团队使用则多出两个维度。共享集合与环境成员可以共享集合文件夹和环境配置新人接入不用逐个复制请求。自托管部署自带管理面板团队与成员权限都在里面管。测试用例进 CI仓库内置的官方 CLI目前处于 alpha 阶段可以解析集合 JSON逐个执行请求及其测试脚本并输出 JUnit 报告。在流水线里跑一条hopp test collection.json接口回归就能自动化完整参数说明见packages/hoppscotch-cli/README.md。这样你在界面里搭好的用例就自然沉淀成了发布流程的一部分。延伸资源README.md项目概览与完整功能清单CONTRIBUTING.md参与开发与提交代码的流程packages/hoppscotch-cli/README.mdCLI 命令与参数参考【免费下载链接】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),仅供参考
