Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/gsoc/contribution-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Google pays the students, not the organizations they work with. Beginning in 202

You can read more about the format of the program and its goals [here](https://google.github.io/gsocguides/mentor/).

<img src="/img/gsoc-banner.png"/>
<img src="/img/gsoc-banner.png" loading="lazy" decoding="async"/>

## Keploy X GSoC

Expand Down
2 changes: 1 addition & 1 deletion docs/hacktoberfest/contribution-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ label: Hacktoberfest

Hacktoberfest'22 is a month-long celebration of open-source software run by DigitalOcean. Hacktoberfest is open to everyone, from first-time contributors to seasoned open-source developers. Your open-source journey begins with a pull request.

<img src="https://user-images.githubusercontent.com/53110238/193503992-c839beeb-53fd-46d7-9214-a88bfff6475a.png"/>
<img src="https://user-images.githubusercontent.com/53110238/193503992-c839beeb-53fd-46d7-9214-a88bfff6475a.png" loading="lazy" decoding="async"/>
Copy link

Copilot AI Apr 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This image tag is missing an alt attribute. Add appropriate alt text (or alt="" if decorative) to avoid screen readers announcing a raw URL/filename and to match versioned_docs/version-1.0.0/hacktoberfest/contribution-guide.md:13 which includes alt for the same image.

Copilot uses AI. Check for mistakes.

## Hacktoberfest Journey with Keploy

Expand Down
6 changes: 3 additions & 3 deletions docs/hacktoberfest/non-code.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ label: Hacktoberfest

There are many ways to contribute to Keploy projects without writing a single line of code. You can help with:

- <img src="https://www.svgrepo.com/show/10712/pencil.svg" width='40px'/> Used Keploy recently ? Tell the community about it in an awesome blog post.
- <img src="https://www.svgrepo.com/show/10712/pencil.svg" width='40px' loading="lazy" decoding="async"/> Used Keploy recently ? Tell the community about it in an awesome blog post.

- <img src="https://www.svgrepo.com/show/157174/document.svg" width='40px'/> Improve Documentation as the more detailed the documentation is, better it will be for people who are looking for help.
- <img src="https://www.svgrepo.com/show/157174/document.svg" width='40px' loading="lazy" decoding="async"/> Improve Documentation as the more detailed the documentation is, better it will be for people who are looking for help.

- <img src="https://www.svgrepo.com/show/294283/youtube.svg" width='40px'/> Create a tutorial because they provide instructions on how to use a tool or service in a step-by-step manner.
- <img src="https://www.svgrepo.com/show/294283/youtube.svg" width='40px' loading="lazy" decoding="async"/> Create a tutorial because they provide instructions on how to use a tool or service in a step-by-step manner.
Comment on lines +11 to +15
Copy link

Copilot AI Apr 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These inline icon images are missing alt. For accessibility, either provide meaningful alt text or mark them decorative with alt="" (and optionally aria-hidden="true"). This is also inconsistent with older docs versions that include alt for the same icons (e.g. versioned_docs/version-2.0.0/hacktoberfest/non-code.md:11-17).

Copilot uses AI. Check for mistakes.
Original file line number Diff line number Diff line change
Expand Up @@ -14,21 +14,21 @@ keywords:

Keploy captures all the API calls and subsequent network traffic served by the application. You can use any existing API management tools like Postman, curl to generate test-case.

<img src="/docs/img/record-api.gif?raw=true" width="80%" alt="API Tools"/>
<img src="/docs/img/record-api.gif?raw=true" width="80%" alt="API Tools" loading="lazy" decoding="async"/>

### 2. Automatically mock Mutations

Keploy automatically [mocks](/concepts/general-glossary.md#1-api-data-mocking) network/external dependencies for **all CRUD operations** with correct responses.

Data dumps, stubs or mocks for dependencies like DBs, internal services, or third party services like twilio, shopify or stripe are **not required**.

<img src="/docs/img/mock-dependencies.png?raw=true" width="50%" alt="Mock Application Dependencies"/>
<img src="/docs/img/mock-dependencies.png?raw=true" width="50%" alt="Mock Application Dependencies" loading="lazy" decoding="async"/>

Please check list of currently supported dependencies in [Go, Java and Node](https://keploy.io/#integrations).

Keploy can safely replay writes or mutations by capturing from local or other environments and replaying without API chaining.

<img src="/docs/gif/record-replay.gif?raw=true" width="80%" alt="API Tools"/>
<img src="/docs/gif/record-replay.gif?raw=true" width="80%" alt="API Tools" loading="lazy" decoding="async"/>

[Idempotency](/concepts/general-glossary.md#2-idempotency) guarantees are also **not required** in the application. Multiple Reads after write operations can be replicated automatically too.

Expand All @@ -38,7 +38,7 @@ Keploy identifies [noisy fields](/concepts/general-glossary.md#3-noisy-field) in

As the application serves the API, Keploy re-run that API request with the captured dependency mocks.

[//]: # '<img src="/docs/img/noise-filtration.png?raw=true" alt="Keploy noise filtration"/>'
[//]: # '<img src="/docs/img/noise-filtration.png?raw=true" alt="Keploy noise filtration" loading="lazy" decoding="async"/>'

Keploy then compares if the responses of the API requests disagree with each other.
If any of the fields of the API responses are different they are marked as random/non-deterministic fields.
Expand All @@ -49,7 +49,7 @@ Keploy has [native integrations](/concepts/general-glossary.md#4-interoperabilit
Code coverage will be reported with existing and Keploy recorded test cases and can also be integrated in
existing CI pipelines easily.

<img src="/docs/gif/replay-tc.gif?raw=true" alt="Keploy Integration with Testing Libraries"/>
<img src="/docs/gif/replay-tc.gif?raw=true" alt="Keploy Integration with Testing Libraries" loading="lazy" decoding="async"/>

### 5. Easy Integration Framework for new Libraries

Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-1.0.0/gsoc/contribution-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Google pays the students, not the organizations they work with. Beginning in 202

You can read more about the format of the program and its goals [here](https://google.github.io/gsocguides/mentor/).

<img src="/docs/img/gsoc-banner.png"/>
<img src="/docs/img/gsoc-banner.png" loading="lazy" decoding="async"/>

## Keploy X GSoC

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ label: Hacktoberfest

Hacktoberfest is a month-long celebration of open-source software run by DigitalOcean. Hacktoberfest is open to everyone, from first-time contributors to seasoned open-source developers. Your open-source journey begins with a pull request.

<img src="https://user-images.githubusercontent.com/53110238/193503992-c839beeb-53fd-46d7-9214-a88bfff6475a.png" alt="hactoberfest"/>
<img src="https://user-images.githubusercontent.com/53110238/193503992-c839beeb-53fd-46d7-9214-a88bfff6475a.png" alt="hactoberfest" loading="lazy" decoding="async"/>

## Hacktoberfest Journey with Keploy

Expand Down
6 changes: 3 additions & 3 deletions versioned_docs/version-1.0.0/hacktoberfest/non-code.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ label: Hacktoberfest

There are many ways to contribute to Keploy projects without writing a single line of code. You can help with:

- <img src="https://www.svgrepo.com/show/10712/pencil.svg" width='40px' alt="pencil"/> Used Keploy recently ? Tell the community about it in an awesome blog post.
- <img src="https://www.svgrepo.com/show/10712/pencil.svg" width='40px' alt="pencil" loading="lazy" decoding="async"/> Used Keploy recently ? Tell the community about it in an awesome blog post.

- <img src="https://www.svgrepo.com/show/157174/document.svg" width='40px' alt="Documents"/> Improve Documentation as the more detailed the documentation is, better it will be for people who are looking for help.
- <img src="https://www.svgrepo.com/show/157174/document.svg" width='40px' alt="Documents" loading="lazy" decoding="async"/> Improve Documentation as the more detailed the documentation is, better it will be for people who are looking for help.

- <img src="https://www.svgrepo.com/show/294283/youtube.svg" width='40px' alt="tutorial"/> Create a tutorial because they provide instructions on how to use a tool or service in a step-by-step manner.
- <img src="https://www.svgrepo.com/show/294283/youtube.svg" width='40px' alt="tutorial" loading="lazy" decoding="async"/> Create a tutorial because they provide instructions on how to use a tool or service in a step-by-step manner.
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ Linux:

| Operating System | Without Docker | Docker Installation | Prerequisites |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <img src="https://www.pngplay.com/wp-content/uploads/3/Apple-Logo-Transparent-Images.png" width="15" height="15" alt="MacOS" /> **MacOS** | [Guide](/keploy-explained/mac-linux.md) | [Guide](/server/installation/) | - Docker Desktop version must be 4.25.2 or above<br/> |
| <img src="https://upload.wikimedia.org/wikipedia/commons/5/5f/Windows_logo_-_2012.svg" width="15" height="15" alt="Windows" /> **Windows** | <img src="https://upload.wikimedia.org/wikipedia/commons/e/e5/Green_tick_pointed.svg" width="20" height="20" alt="Supported" /> | <img src="https://upload.wikimedia.org/wikipedia/commons/e/e5/Green_tick_pointed.svg" width="20" height="20" alt="Supported" /> | - Use [WSL](https://learn.microsoft.com/en-us/windows/wsl/install#install-wsl-command) `wsl --install` <br/> - Windows 10 version 2004 and higher (Build 19041 and higher) or Windows 11 |
| <img src="https://th.bing.com/th/id/R.7802b52b7916c00014450891496fe04a?rik=r8GZM4o2Ch1tHQ&riu=http%3a%2f%2f1000logos.net%2fwp-content%2fuploads%2f2017%2f03%2fLINUX-LOGO.png&ehk=5m0lBvAd%2bzhvGg%2fu4i3%2f4EEHhF4N0PuzR%2fBmC1lFzfw%3d&risl=&pid=ImgRaw&r=0" width="10" height="10" alt="Linux" /> **Linux** | <img src="https://upload.wikimedia.org/wikipedia/commons/e/e5/Green_tick_pointed.svg" width="20" height="20" alt="Supported" /> | <img src="https://upload.wikimedia.org/wikipedia/commons/e/e5/Green_tick_pointed.svg" width="20" height="20" alt="Supported" /> | Linux kernel 5.15 or higher |
| <img src="https://www.pngplay.com/wp-content/uploads/3/Apple-Logo-Transparent-Images.png" width="15" height="15" alt="MacOS" loading="lazy" decoding="async"/> **MacOS** | [Guide](/keploy-explained/mac-linux.md) | [Guide](/server/installation/) | - Docker Desktop version must be 4.25.2 or above<br/> |
| <img src="https://upload.wikimedia.org/wikipedia/commons/5/5f/Windows_logo_-_2012.svg" width="15" height="15" alt="Windows" loading="lazy" decoding="async"/> **Windows** | <img src="https://upload.wikimedia.org/wikipedia/commons/e/e5/Green_tick_pointed.svg" width="20" height="20" alt="Supported" loading="lazy" decoding="async"/> | <img src="https://upload.wikimedia.org/wikipedia/commons/e/e5/Green_tick_pointed.svg" width="20" height="20" alt="Supported" loading="lazy" decoding="async"/> | - Use [WSL](https://learn.microsoft.com/en-us/windows/wsl/install#install-wsl-command) `wsl --install` <br/> - Windows 10 version 2004 and higher (Build 19041 and higher) or Windows 11 |
| <img src="https://th.bing.com/th/id/R.7802b52b7916c00014450891496fe04a?rik=r8GZM4o2Ch1tHQ&riu=http%3a%2f%2f1000logos.net%2fwp-content%2fuploads%2f2017%2f03%2fLINUX-LOGO.png&ehk=5m0lBvAd%2bzhvGg%2fu4i3%2f4EEHhF4N0PuzR%2fBmC1lFzfw%3d&risl=&pid=ImgRaw&r=0" width="10" height="10" alt="Linux" loading="lazy" decoding="async"/> **Linux** | <img src="https://upload.wikimedia.org/wikipedia/commons/e/e5/Green_tick_pointed.svg" width="20" height="20" alt="Supported" loading="lazy" decoding="async"/> | <img src="https://upload.wikimedia.org/wikipedia/commons/e/e5/Green_tick_pointed.svg" width="20" height="20" alt="Supported" loading="lazy" decoding="async"/> | Linux kernel 5.15 or higher |

On MacOS and Windows, additional tools are required for Keploy due to the lack of native eBPF support.
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Despite the challenges, E2E testing is an important part of the software develop

Keploy generate E2E API tests with built-in-mocks or stubs by recording your application network calls making your testing process not only faster than unit tests but also incredibly efficient.

<img src="https://keploy.io/docs/gif/record-tc.gif"/>
<img src="https://keploy.io/docs/gif/record-tc.gif" loading="lazy" decoding="async"/>

### How Keploy works?

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Microservice testing is the process of validating individual components of a mic
## Overcoming Challenges with Keploy

Keploy is an innovative testing tool designed to address many of the challenges associated with microservices testing. Here's how it helps:
<img src="https://keploy.io/docs/gif/record-replay.gif?raw=true"/>
<img src="https://keploy.io/docs/gif/record-replay.gif?raw=true" loading="lazy" decoding="async"/>
<br/>

- **Automated Test Case Generation**: Keploy can generate test cases by recording your application's network calls. This automation significantly reduces the time and effort required to create comprehensive test suites.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,6 @@ Data mocks refer to the synthetic data that mimics real-world datasets, which is

Keploy can generate dependency mocks in addition to the testcases by recording your application network calls making your testing process not only faster than unit tests but also incredibly efficient.

<img src="https://keploy.io/docs/gif/record-replay.gif?raw=true"/>
<img src="https://keploy.io/docs/gif/record-replay.gif?raw=true" loading="lazy" decoding="async"/>

Since these data mocks are generated based on the real-time capturing of API calls from your application, they will be from real-world scenarios. This can help to ensure that the data mocks are accurate and that it represents the real data as closely as possible. As well as, it makes the data maintenance process easier by providing a same environment for testing. This can help to identify the source of bugs more easily.
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,6 @@ Overall, stubs are a valuable tool for software development and testing. They ca

Keploy can generate dependency stubs in addition to the testcases by recording your application network calls making your testing process not only faster than unit tests but also incredibly efficient.

<img src="https://keploy.io/docs/gif/record-replay.gif?raw=true"/>
<img src="https://keploy.io/docs/gif/record-replay.gif?raw=true" loading="lazy" decoding="async"/>

Since the data stubs are generated based on the real-time capturing of API calls from your application, they will be from real-world scenarios. This can help to ensure that the mock data is accurate and that it represents the real data as closely as possible. As well as, it makes the data maintenance process easier by providing a same environment for testing. This can help to identify the source of bugs more easily.
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Keploy has [native integrations](/concepts/general-glossary.md#4-interoperabilit
like `go-test`, `jUnit`, `jest`, `pyTest`. Keploy gives combined test-coverage and can also be integrated in existing CI
pipelines easily within `go-test`, `jUnit`, `jest`, `pyTest` workflows.

<img src="/docs/gif/replay-tc.gif?raw=true" alt="Keploy Integration with Testing Libraries" width="80%"/>
<img src="/docs/gif/replay-tc.gif?raw=true" alt="Keploy Integration with Testing Libraries" width="80%" loading="lazy" decoding="async"/>

Run tests with mocks anywhere you like—**locally on the CLI**, in your **CI pipeline**, or even across a **Kubernetes
cluster**. It's testing wherever you want it! 🌍
Expand All @@ -49,20 +49,20 @@ favorite API management tools like Postman or even Curl to generate test cases.
Keploy automatically [mocks](/concepts/general-glossary.md#1-api-data-mocking) network/external dependencies for **all
CRUD operations** with correct responses.

<img src="/docs/gif/record-replay.gif?raw=true" width="80%" alt="API Tools"/>
<img src="/docs/gif/record-replay.gif?raw=true" width="80%" alt="API Tools" loading="lazy" decoding="async"/>

Once recorded, you have the flexibility to replay and simulate the same flow with mutations/write calls locally or
within your CI environment without needing to connect to external services/dependencies.

No more data dumps, stubs, or mocks for dependencies like DBs, internal services, or third-party services like twilio,
shopify, or stripe are required anymore. 💡

<img src="/docs/img/mock-dependencies.png?raw=true" width="50%" alt="Mock Application Dependencies" style={{backgroundColor: '#EDEDED'}}/>
<img src="/docs/img/mock-dependencies.png?raw=true" width="50%" alt="Mock Application Dependencies" style={{backgroundColor: '#EDEDED'}} loading="lazy" decoding="async"/>

[Idempotency](/concepts/general-glossary.md#2-idempotency) guarantees are also **not required** in the application.
Multiple Reads after write operations can be replicated automatically too. 🔄

[//]: # '<img src="/docs/img/record-api.gif?raw=true" width="80%" alt="API Tools"/>'
[//]: # '<img src="/docs/img/record-api.gif?raw=true" width="80%" alt="API Tools" loading="lazy" decoding="async"/>'

## ♻️ Multi-Purpose Mocks

Expand All @@ -86,7 +86,7 @@ timestamps, random values) to ensure high quality tests.

As the application serves the API, Keploy re-run that API request with the captured dependency mocks.

[//]: # '<img src="/img/noise-filtration.png?raw=true" alt="Keploy noise filtration"/>'
[//]: # '<img src="/img/noise-filtration.png?raw=true" alt="Keploy noise filtration" loading="lazy" decoding="async"/>'

Keploy identifies differences in API responses, marking them as random/noisy fields. 🧐✅

Expand Down
Loading