Keploy 快速安装教程:5 分钟跑通 API 测试的记录与回放
【免费下载链接】keployOpen-source platform for creating safe, isolated production sandboxes for API, integration, and E2E testing.项目地址: https://gitcode.com/GitHub_Trending/ke/keploy
Keploy 是一个开源的 API 与集成测试平台,能把应用的真实流量自动转成可回放的测试用例和 mock。这篇 Keploy 快速上手教程只有一条安装命令和两条 record/test 命令,约 5 分钟完成安装、验证与第一次回放,并覆盖 Linux、macOS 与非 root 用户三种场景。
先解决一个真实痛点:集成测试的依赖搭不起
这一节先说清楚 Keploy 帮你解决什么问题,再决定要不要装。写集成测试时,你往往要先把数据库、消息队列、外部 API 的 mock 一个个搭起来,搭完还要跟着接口变更一起维护。Keploy 的思路相反:它用 eBPF 在网络层抓包,把你应用的真实 API 调用、数据库查询、流式事件原样录下来,存成测试用例和 mock 数据;回放时按录制内容确定性重放。全程不改代码、不挑语言,Go、Node、Java、Python 都能直接跑。
确认你的环境在下一节的支持列表里,然后直接开始装。
安装前快速决策:环境要求与适用场景
这一节帮你花 30 秒判断该不该装、怎么装,避免装到一半才发现环境不支持。
| 平台 | 支持的架构 | 安装行为 |
|---|---|---|
| Linux | x86_64、aarch64 | 默认以 root 安装,可用-noRoot改为用户级 |
| macOS | 全部架构 | 脚本强制用户级安装,无需 sudo |
| Windows | 不支持 | 脚本会提示改用 WSL2 运行 |
- 适合你:维护 Go / Node / Java / Python 服务,想在不连真实依赖的前提下跑集成测试和 E2E 测试。
- 不适合你:只需要单元测试,或者工具本体必须跑在 Windows 上。
满足要求的话,复制下一节的命令即可。
5 分钟装完 Keploy:安装与验证一步完成
这一节给你最短路径:一条命令装完,脚本自动检测架构、选包、配置 PATH,并在装完时自动跑一次验证。
curl -O https://gitcode.com/GitHub_Trending/ke/keploy/raw/branch/master/keploy.sh && chmod +x keploy.sh && ./keploy.sh- 下载阶段是彩色进度条实时显示百分比,解压、移动等后台步骤用 spinner 动画提示,卡在哪一步一目了然。
- 脚本按系统选包:Linux x86_64 装 amd64 包,aarch64 装 arm64 包,macOS 装 darwin 包。
- 在 Linux 上安装 v2.x 版本时,脚本会把带 sudo 的 keploy 别名写进 shell 配置(eBPF 操作需要提权);非 root 模式则把
~/.keploy/bin加入 PATH。 - 装完后脚本会自动执行一次
keploy example验证二进制可用,随后清理 keploy.sh 等临时文件。
✅ 看到按语言分组的 record / test 命令清单(Golang、Node、Java、Docker)就说明安装成功。如果你的网络拉不下来脚本,可以先git clone https://gitcode.com/GitHub_Trending/ke/keploy,再在仓库目录里执行./keploy.sh。
验证输出正常后,就带着自己的应用进下一节跑第一条实战命令。
装完立刻能用:record 与 test 两条命令跑通
这一节给你两个最小实战示例,跑完你会对整套流程有确定感。以 Node 服务为例:
keploy record -c "npm start --prefix /path/to/node/app"预期效果:Keploy 拉起你的应用并录制真实流量;录制结束后,当前目录的 keploy 目录下会生成 test-set 目录,里面就是产出的测试用例和 mock 数据。
keploy test -c "npm start --prefix /path/to/node/app" --delay 10预期效果:不依赖真实数据库和中间件,Keploy 用录制好的 mock 启动应用并逐个回放 test-set,最后输出每个用例的通过与否报告。其他语言的现成命令随时运行keploy example查看;如果你不是通过一键脚本安装的,用keploy example --customSetup true可以看到包含 Docker 方式的完整清单。
如果你的环境不是默认情况——要锁版本、非 root、或者在 CI 里跑——看下一节对应的参数。
按需进阶:什么场景带什么参数
这一节把安装参数按使用场景拆开,遇到哪个场景就带哪个参数,不用背。
锁定指定版本安装 Keploy
版本格式是-v v<大版本.小版本.修订号>,格式不合法会直接报错退出:
./keploy.sh -v v2.0.0非root用户安装的正确姿势
没有 sudo 权限时加-noRoot,二进制装到$HOME/.keploy/bin,脚本会按你当前的 shell 把 PATH 写进.bashrc、.zshrc或.profile:
./keploy.sh -noRootCI 环境专用安装模式
流水线里加-isCI,脚本只走架构检测与安装流程,跳过本地环境特有的处理:
./keploy.sh -isCI下载失败时的手动替代方案
从官方 Releases 手动下载对应架构的keploy_linux_amd64.tar.gz、keploy_linux_arm64.tar.gz或keploy_darwin_all.tar.gz,解压后把keploy可执行文件放进 PATH 中的任意目录即可,效果和脚本安装一致。
只要开源版二进制
确定不需要社区版安装器时加--oss,脚本会直接下载对应架构的 OSS 包:
./keploy.sh --oss参数用对之后,剩下的高频问题基本都能在下面的避坑清单里找到。
避坑清单:现象、原因与解法对照
这一节把常见问题统一按"现象 → 原因 → 解法"排列,出问题时直接对号入座。
- ⚠️ 现象:脚本报
Unsupported architecture: xxx。原因:只支持 x86_64、aarch64 和 macOS。解法:用uname -m确认架构;Windows 用户按脚本提示安装 WSL2 后在 Linux 环境内执行。 - 现象:装完执行
keploy提示 command not found。原因:非 root 模式装在~/.keploy/bin,当前 shell 还没加载新 PATH。解法:执行source ~/.bashrc(zsh 用户用~/.zshrc),或重开一个终端。 - 现象:安装时报 permission denied。原因:没有写
/usr/local/bin的 sudo 权限。解法:改用./keploy.sh -noRoot走用户级安装。 - 现象:
keploy record执行中弹出 sudo 密码提示。原因:Linux 上 eBPF 操作需要提权,这是预期行为。解法:输入密码继续,或改用-noRoot模式自行处理权限。
遇到清单之外的问题,就从下一节的入口去查文档和源码。
延伸入口:文档、源码与社区
这一节给你装完之后该去哪里的三个入口。项目总览与 quick start 在 README.md;安装脚本的架构检测、别名配置与清理逻辑都写在 keploy.sh 里,看不懂某一步可以对照着看;想理解命令行结构,从 main.go 和 cli/ 目录入手,mock 生命周期等解释性文档在 docs/ 目录。下一步建议:挑一个你维护的服务跑一次keploy record,把生成的 test-set 提交进 CI,用keploy test让回放替你守住回归。
【免费下载链接】keployOpen-source platform for creating safe, isolated production sandboxes for API, integration, and E2E testing.项目地址: https://gitcode.com/GitHub_Trending/ke/keploy
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考