Back to Keploy

README

README.md

3.5.2210.9 KB
Original Source
<p align="center"> </p> <p align="center"> <a href="https://trendshift.io/repositories/3262" target="_blank"> </a> </p> <h3 align="center"><b>⚡️ API tests faster than unit tests, from user traffic ⚡️</b></h3> <p align="center">🌟 The must-have tool for developers in the AI-Gen era for 90% test coverage 🌟</p>
<p align="center"> <a href="https://join.slack.com/t/keploy/shared_invite/zt-357qqm9b5-PbZRVu3Yt2rJIa6ofrwWNg"></a> <a href="https://www.linkedin.com/company/keploy/"></a> <a href="https://www.youtube.com/channel/UC6OTg7F4o0WkmNtSoob34lg"></a> <a href="https://x.com/Keployio"></a> </p> <p align="center"> <a href="https://landscape.cncf.io/?item=app-definition-and-development--continuous-integration-delivery--keploy"> </a> <a href="https://github.com/Keploy/Keploy/stargazers"></a> <a href="https://github.com/Keploy/Keploy/"> </a> </p>

Keploy is a developer‑centric API and integration testing tool that auto‑generates tests and data‑mocks faster than unit tests.

It records API calls, database queries, and streaming events — then replays them as tests. Under the hood, Keploy uses eBPF to capture traffic at the network layer, but for you it’s completely code‑less and language‑agnostic.

🐰 Fun fact: Keploy uses itself for testing! Check out our swanky coverage badge:  


Key Highlights

🎯 No code changes

Just run your app with keploy record. Real API + integration flows are automatically captured as tests and mocks. (Keploy uses eBPF under the hood to capture traffic, so you don’t need to add any SDKs or modify code.)

📹 Record and Replay complex Flows

Keploy can record and replay complex, distributed API flows as mocks and stubs. It's like having a very light-weight time machine for your tests—saving you tons of time!

👉 Read the docs on record-replay

🐇 Complete Infra‑Virtualization (beyond HTTP mocks)

Unlike tools that only mock HTTP endpoints, Keploy records databases (Postgres, MySQL, MongoDB), streaming/queues (Kafka, RabbitMQ), external APIs, and more.

It replays them deterministically so you can run tests without re‑provisioning infra.

👉 Read the docs on infra virtualisation

🧪 Combined Test Coverage

If you’re a developer, you probably care about statement and branch coverage — Keploy calculates that for you.

If you’re a QA, you focus more on API schema and business use‑case coverage — Keploy calculates that too. This way coverage isn’t subjective anymore.

👉 Read the docs on coverage

🤖 Expand API Coverage using AI

Keploy uses existing recordings, Swagger/OpenAPI Schema to find: boundary values, missing/extra fields, wrong types, out‑of‑order sequences, retries/timeouts.

This helps expand API Schema, Statement, and Branch Coverage.

👉 Read the docs on coverage

Other Capabilities

  • 🌐 CI/CD Integration: Run tests with mocks anywhere you like—locally on the CLI, in your CI pipeline (Jenkins, Github Actions..) , or even across a Kubernetes cluster. Read more

  • 🎭 Multi-Purpose Mocks: You can also use Keploy-generated Mocks, as server Tests!

  • 📊 Reporting: Unified reports for API, integration, unit, and e2e coverage with insights directly in your CI or PRs.

  • 🖥️ Console: A developer-friendly console to view, manage, and debug recorded tests and mocks.

  • ⏱️ Time Freezing: Deterministically replay tests by freezing system time during execution. Read more

  • 📚 Mock Registry: Centralized registry to manage, reuse, and version mocks across teams and environments. Read more


Quick Start

1. Install Keploy Agent

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

2. Record Test Cases

Start your app under Keploy to convert real API calls into tests and mocks.

bash
keploy record -c "CMD_TO_RUN_APP"

Example for Python:

bash
keploy record -c "python main.py"

3. Run Tests

Run tests offline without external dependencies.

bash
keploy test -c "CMD_TO_RUN_APP" --delay 10

Resources

- 📘 Installation

- 🏁 QuickStarts


Languages & Frameworks (Any stack)

Because Keploy intercepts at the network layer (eBPF), it works with any language, framework, or runtime—no SDK required.

Note: Some of the dependencies are not open-source by nature because their protocols and parsings are not open-sourced. It's not supported in Keploy enterprise.

<p align="center"> <!-- Languages --> <!-- Protocols &amp; infra commonly virtualized --> </p>

Questions?

Book a Live Demo / Enterprise Support

Want a guided walkthrough, dedicated support, or help planning enterprise rollout?

<p> <a href="https://calendar.app.google/4ZKd1nz9A5wLuP4W7"> </a> &nbsp; <a href="https://join.slack.com/t/keploy/shared_invite/zt-357qqm9b5-PbZRVu3Yt2rJIa6ofrwWNg"> </a> <!-- Optional: replace with your scheduling link (Cal.com/Calendly) --> <!-- <a href="https://cal.com/keploy/demo"></a> --> </p>

Prefer a calendar invite? Mention your availability in the email—we’ll send a calendar invite right away.


Documentation & Community


Contribute & Collaborate

Whether you're new or experienced, your input matters. Help us improve Keploy by contributing code, reporting issues, or sharing feedback.

Together, let's build better testing tools for modern applications.