⚡️ API测试速度超越单元测试，源自真实用户流量 ⚡️

🌟 AI时代开发者必备工具，助你实现90%测试覆盖率 🌟

---

Keploy 是一款以开发者为中心的 API 和集成测试工具，能够比单元测试更快地自动生成测试用例和数据模拟。它会记录 API 调用、数据库查询以及流式事件，然后将这些记录回放为测试。在底层，Keploy 使用 eBPF 在网络层捕获流量，但对您来说，它完全无需编写代码且与语言无关。

🐰 小知识： Keploy 自己也用自身进行测试！来看看我们炫酷的覆盖率徽章：  

---

核心亮点

🎯 无需修改代码

只需运行 keploy record 即可。真实的 API 和集成流程会自动被捕捉为测试用例和模拟数据。(Keploy 底层使用 eBPF 捕获流量，因此您无需添加任何 SDK 或修改代码。)

📹 记录并回放复杂流程

Keploy 可以记录并回放复杂的分布式 API 流程作为模拟和桩件。这就像是为您的测试配备了一台轻量级的时间机器——为您节省大量时间！

👉 阅读关于录制与回放的文档

🐇 完整的基础设施虚拟化（超越HTTP模拟）

与其他仅模拟 HTTP 端点的工具不同，Keploy 还会记录数据库（Postgres、MySQL、MongoDB）、消息队列（Kafka、RabbitMQ）以及外部 API 等。它可以确定性地回放这些内容，让您无需重新部署基础设施即可运行测试。

👉 阅读关于基础设施虚拟化的文档

🧪 综合测试覆盖率

如果您是开发者，可能更关心语句覆盖和分支覆盖；而如果是 QA，则更关注 API Schema 和业务用例覆盖。Keploy 都能为您计算出来，让覆盖率不再主观。

👉 阅读关于覆盖率的文档

🤖 利用AI扩展API覆盖率

Keploy 会基于现有录制内容和 Swagger/OpenAPI Schema，找出边界值、缺失或多余的字段、错误类型、顺序错乱以及重试/超时等问题。这有助于提升 API Schema、语句和分支覆盖率。

👉 阅读关于覆盖率的文档

其他功能

• 🌐 CI/CD集成： 您可以在任何地方运行带模拟数据的测试——本地 CLI、CI 流水线（Jenkins、Github Actions等），甚至跨 Kubernetes 集群。了解更多
• 🎭 多用途模拟： 您还可以将 Keploy 生成的模拟数据用作服务器端测试！
• 📊 报告： 统一的 API、集成、单元和端到端覆盖率报告，并在 CI 或 PR 中提供洞察。
• 🖥️ 控制台： 开发者友好的控制台，用于查看、管理和调试已录制的测试用例和模拟数据。
• ⏱️ 时间冻结： 在执行过程中冻结系统时间，实现确定性的测试回放。了解更多
• 📚 模拟注册表： 集中式的注册表，用于管理、复用和版本化团队及环境间的模拟数据。了解更多

---

快速入门

1. 安装 Keploy Agent

curl --silent -O -L https://keploy.io/install.sh && source install.sh

2. 录制测试用例

在 Keploy 下启动您的应用，将真实的 API 调用转换成测试用例和模拟数据。

keploy record -c "CMD_TO_RUN_APP"

Python 示例：

keploy record -c "python main.py"

3. 运行测试

无需外部依赖，即可离线运行测试。

keploy test -c "CMD_TO_RUN_APP" --delay 10

资源

- 📘 安装指南

- 🏁 快速入门

---

语言与框架（任意技术栈）

由于 Keploy 在 网络层（eBPF） 进行拦截，因此它适用于 任何语言、框架或运行时——无需 SDK。

注意：部分依赖本身并非开源，因为其协议和解析方式并未公开。Keploy 企业版不支持这些内容。

---

有任何问题吗？

预约现场演示 / 企业级支持

想要获得指导性演示、专属支持，或是协助规划企业级部署方案吗？

 

如果您更喜欢日历邀请，请在邮件中注明您的空闲时间，我们会立即发送一封 日历邀请。

---

文档与社区

• 📘 文档 — 浏览完整文档
• 💬 Slack 社区 — 加入讨论
• 📜 贡献指南
• ❤️ 行为准则
• 📢 博客 — 阅读文章和最新动态

---

贡献与协作

无论您是新手还是资深开发者，您的意见都至关重要。请通过提交代码、报告问题或分享反馈来帮助我们改进 Keploy。

让我们携手共建更优秀的现代应用测试工具。

Keploy 快速上手指南

Keploy 是一款以开发者为中心的 API 和集成测试工具。它利用 eBPF 技术在网络层自动捕获真实的 API 调用、数据库查询和流事件，并将其转化为可重放的测试用例和数据 Mock。无需修改代码、无需嵌入 SDK、语言无关，即可实现比单元测试更快的测试覆盖。

环境准备

系统要求

由于 Keploy 底层依赖 eBPF 技术进行流量拦截，请确保您的运行环境满足以下条件：

• 操作系统：Linux (推荐 Ubuntu 20.04+, Debian, Fedora, CentOS 7+) 或 macOS (需安装 Docker Desktop 并启用 Linux 虚拟机)。
  • 注意：Windows 用户建议通过 WSL2 (Windows Subsystem for Linux) 运行。
• 内核版本：Linux Kernel 4.19 或更高版本（推荐 5.x+ 以获得最佳 eBPF 支持）。
• 权限：需要 sudo 权限以加载 eBPF 程序。

前置依赖

• Docker (可选但推荐)：用于在隔离环境中运行应用，避免污染本地环境。
• curl：用于下载安装脚本。
• 目标应用：任何语言的后端服务（Go, Java, Python, Node.js, Rust 等），只要它能通过 HTTP/gRPC 等协议通信。

安装步骤

Keploy 提供了一键安装脚本，会自动检测系统架构并下载对应的二进制文件。

在终端执行以下命令：

curl --silent -O -L https://keploy.io/install.sh && source install.sh

安装完成后，验证是否安装成功：

keploy version

提示：如果下载速度较慢，可尝试配置国内代理或使用支持断点续传的下载工具获取 install.sh 脚本后本地执行。

基本使用

Keploy 的核心工作流分为两步：录制 (Record) 和 回放 (Test)。

1. 录制测试用例 (Record)

启动您的应用程序，Keploy 会自动拦截并记录所有的进出流量（API 请求、数据库调用等），生成测试文件和 Mock 数据。

将 "CMD_TO_RUN_APP" 替换为您实际启动应用的命令。

通用命令：

keploy record -c "CMD_TO_RUN_APP"

示例（以 Python Flask 应用为例）：

keploy record -c "python main.py"

操作指引：

1. 运行上述命令后，保持终端不要关闭。
2. 使用 Postman、curl 或前端页面对您的 API 发起几次真实请求。
3. 按下 Ctrl + C 停止录制。
4. 当前目录下会生成 keploy 文件夹，包含录制好的测试用例 (tests) 和 Mock 数据 (mocks)。

2. 回放测试 (Test)

在离线状态下运行测试。Keploy 会重放录制的流量，并使用生成的 Mock 数据模拟外部依赖（如数据库、第三方 API），无需真实连接基础设施。

通用命令：

keploy test -c "CMD_TO_RUN_APP" --delay 10

示例（继续以上述 Python 应用为例）：

keploy test -c "python main.py" --delay 10

参数说明：

• -c: 启动应用的命令。
• --delay 10: 给应用启动预留 10 秒缓冲时间（根据应用实际启动速度调整）。

运行结束后，终端将直接输出测试对比报告，显示预期响应与实际响应是否一致。

---

下一步建议：

• 将 keploy test 命令集成到您的 CI/CD 流水线（GitHub Actions, Jenkins 等）中。
• 访问 Keploy 官方文档 了解如何配置过滤规则、自定义 Mock 策略及结合 AI 扩展测试覆盖率。