Keploy

Keploy Documentation – Go Quickstart & Testing Guide

Keploy helps developers automatically generate tests using real application traffic.
Instead of relying on mocks, Keploy records real requests, responses, and database calls to validate application behavior reliably.


Integration Testing

Integration testing ensures your application works correctly with databases, APIs, and external services.
Keploy records real interactions and replays them during testing to catch regressions that traditional mocks often miss.

Keploy is optimized for real-world integration testing rather than synthetic mocks.


How Keploy Works

Keploy runs alongside your application and records traffic flowing through it.
It captures incoming requests, internal calls, database queries, and responses, then replays them during test execution to verify behavior.

Client
Keploy
App
Database

API Testing

Keploy enables automated API testing without writing test cases manually.
Recorded API requests are replayed to validate response payloads, headers, and status codes across releases.

This helps backend teams detect breaking changes early with minimal effort.


Unit Testing

Keploy does not replace unit testing.
Instead, it complements unit tests by validating real execution paths and full request–response behavior.

Use unit tests for business logic and Keploy for behavior validation.


Installation

Keploy can be installed quickly and integrates seamlessly with Docker-based workflows.
Make sure the following prerequisites are available before installing.

Prerequisites

  • Go ≥ 1.20
  • Docker Desktop
  • Git
Install Keploy CLI

curl --silent --location https://get.keploy.io | bash


Go Quickstart

This quickstart demonstrates using Keploy with a Go (Gin) application.
You will run a sample service, record real API traffic, and replay it as automated test cases.

Official Go Quickstart

https://keploy.io/docs/quickstart/golang-filter/


CLI Commands

Keploy provides a simple CLI to control recording and testing workflows.
These commands are commonly used during development and CI pipelines.

keploy record
keploy test
keploy config
keploy version

CLI Documentation

https://keploy.io/docs/running-keploy/cli-commands/


Configuration

Keploy configuration allows fine-grained control over how tests are recorded and replayed.
You can configure filters, noise suppression rules, storage paths, and environment-specific behavior.

Configuration Reference

https://keploy.io/docs/running-keploy/configuration-file/