Skip to content

Commit f21901c

Browse files
committed
add: revamp unit and api docs page
Signed-off-by: Achanandhi-M <achanandhi.m@gmail.com>
1 parent d3f0040 commit f21901c

22 files changed

+604
-816
lines changed

src/components/QuickStart.js

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,26 +5,23 @@ import useBaseUrl from "@docusaurus/useBaseUrl";
55
export const QuickStart = () => {
66
return (
77
<section className="mt-1">
8-
<h1 className="mb-4 text-4xl font-semibold tracking-wide md:text-5xl">
8+
<h1 className="mb-4 text-4xl font-semibold tracking-wide md:text-4xl">
99
Welcome to Keploy Documentation! 🚀
1010
</h1>
1111
<p className="text-l max-w-3xl">
12-
This documentation is your roadmap to becoming a Keploy expert, whether
13-
you're a seasoned developer or just starting out. 🗺️
12+
This documentation will help you get the most out of Keploy—whether
13+
you’re building your first project or leveling up your testing workflow.
14+
🗺️
1415
</p>
1516

1617
<h2 className="mb-4 mt-8 text-2xl font-semibold tracking-wide md:text-3xl">
1718
What is Keploy? 🤔
1819
</h2>
1920
<p className="text-l max-w-4xl">
20-
Keploy is your open-source, developer-centric backend testing tool. It
21-
makes backend testing easy and productive for engineering teams. Plus,
22-
it's easy-to-use, powerful and extensible..🛠️
23-
</p>
24-
<p className="text-l mt-4 max-w-4xl">
25-
Keploy creates test cases and data mocks/stubs from user-traffic by
26-
recording API calls and DB queries, significantly speeding up releases
27-
and enhancing reliability. 📈
21+
Keploy is an AI-powered tool that generates test cases and mocks/stubs
22+
for unit, integration, and API testing, helping developers achieve 90%
23+
test coverage in minutes. With open-source automation and enhanced test
24+
reliability, Keploy simplifies testing workflows.
2825
</p>
2926
{/*
3027
<h2 className="mt-8 text-2xl font-semibold tracking-wide md:text-3xl">

src/components/UTGMethods.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ import useBaseUrl from "@docusaurus/useBaseUrl";
44

55
function UTGMethods() {
66
return (
7-
<div className="rounded-lg mb-8">
7+
<div className="mb-8 rounded-lg">
88
<h2 className="mb-6 text-2xl font-semibold tracking-wide md:text-3xl">
99
Three Ways to Generate Unit Tests 🚀
1010
</h2>
11-
<p className="text-lg max-w-4xl mb-6">
11+
<p className="mb-6 max-w-4xl text-lg">
1212
Choose the method that best fits your workflow - from automated PR
1313
integration to one-click IDE generation:
1414
</p>
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
id: ai-models
3+
title: How Keploy Uses AI Models for Testing
4+
sidebar_label: How Keploy Uses AI Models for Testing
5+
description: How Keploy leverages state-of-the-art AI models for next-generation testing automation.
6+
tags:
7+
- AI
8+
- LLM
9+
- unit testing
10+
- Gemini
11+
- GPT-4
12+
---
13+
14+
# 🤖 AI Models at Keploy
15+
16+
Keploy is a vertical testing agent, built to generate high-quality unit tests using the world’s best AI.
17+
18+
19+
We don’t just rely on one model—we harness the strengths of multiple cutting-edge LLMs to give you smarter, more accurate, and more relevant tests.
20+
21+
## 🚀 Multi-Model, Multi-Benefit
22+
23+
- **Gemini 2.5 Pro (Google):** Advanced reasoning, code understanding, and context awareness.
24+
- **GPT-4 Family (OpenAI):** Exceptional language ability, coverage of edge cases, and broad code knowledge.
25+
- **Other Specialized Models:** We continuously evaluate and integrate new AI models to keep raising the bar for testing automation.
26+
27+
By combining different models, Keploy can generate better test cases, filter out weak tests, and cover more scenarios.
28+
29+
## 🏗️ How It Works
30+
31+
- **Best of All Worlds:** For each test file, Keploy routes tasks to different models—letting each one play to its strengths.
32+
- **Quality Over Quantity:** Results are validated and cross-checked, so you get fewer, but stronger and more useful tests.
33+
- **Rapid Updates:** As AI models evolve, Keploy upgrades seamlessly—always keeping you on the leading edge.
34+
35+
## 🌐 Transparency & User Trust
36+
37+
- **No Code Used for Training:** Your code and test data are **never** used to train any external AI model.
38+
39+
- **Model Selection:** We choose models for you automatically, but always with a focus on security, reliability, and test quality.
40+
41+
Want to learn more about how AI powers Keploy? [Contact us](mailto:support@keploy.io)
Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
id: api-testing-faq
3+
title: API Testing – Frequently Asked Questions
4+
sidebar_label: FAQs
5+
description: Answers to the most common questions about API testing with Keploy.
6+
tags:
7+
- explanation
8+
- faq
9+
---
10+
11+
# Got Questions? We’ve Got Answers! 🚀
12+
13+
Everything you want to know about API testing with Keploy—straightforward and no fluff.
14+
15+
### 1. What types of API tests can Keploy generate?
16+
17+
Keploy automatically creates:
18+
19+
- **Functional Tests:** CRUD operations, endpoint validation
20+
- **Edge Case Tests:** Invalid payloads, error responses
21+
- **Performance Tests:** Response time checks
22+
- **Security Tests:** Input sanitization, auth validation
23+
- **Dependency Tests:** Mocked external service calls
24+
25+
### 2. How does Keploy handle authentication in API tests?
26+
27+
Keploy supports:
28+
29+
- **Auth Types:** JWT, OAuth2, API Keys, Basic Auth
30+
- **Auto-Renewal:** Token refresh flows
31+
- **Test Isolation:** Separate auth contexts per test
32+
- **Security:** No raw credentials stored—uses environment variables
33+
34+
### 3. What protocols and formats does Keploy support?
35+
36+
| Protocol | Formats | Features |
37+
| ---------- | ---------------- | ----------------- |
38+
| HTTP/HTTPS | JSON, XML | Full support |
39+
| gRPC | Protocol Buffers | Code generation |
40+
| WebSockets | JSON, Binary | Session testing |
41+
| GraphQL | Query/Mutation | Schema validation |
42+
43+
### 4. How does test generation work for stateful APIs?
44+
45+
Keploy handles stateful workflows by:
46+
47+
1. Recording session cookies/headers
48+
2. Detecting data dependencies between calls
49+
3. Generating cleanup steps (teardown)
50+
4. Creating isolated test contexts
51+
52+
**Example:**
53+
`POST /cart → GET /cart → POST /checkout → GET /order/{id}`
54+
55+
Hope this helps you out, if you still have any questions, reach out to us .
56+
57+
import GetSupport from '../concepts/support.md'
58+
59+
<GetSupport/>

versioned_docs/version-2.0.0/keploy-explained/how-keploy-utg-works.md

Lines changed: 0 additions & 170 deletions
This file was deleted.

versioned_docs/version-2.0.0/keploy-explained/how-keploy-works.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: how-keploy-works
33
title: How Keploy Works?
4-
sidebar_label: How Keploy Works?
4+
sidebar_label: Architecture
55
tags:
66
- explanation
77
- replay-test-case

versioned_docs/version-2.0.0/keploy-explained/faq.md renamed to versioned_docs/version-2.0.0/keploy-explained/integration-testing-faq.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
---
2-
id: faq
3-
title: Frequently Asked Questions (FAQ)
4-
sidebar_label: FAQ
2+
id: integration-testing-faq
3+
title: Frequently Asked Questions
4+
sidebar_label: FAQs
55
tags:
66
- explanation
77
- faq
88
---
99

10+
# Got Questions? We’ve Got Answers! 🚀
11+
1012
Let's get to the heart of Keploy with some fun Q&A!
1113

1214
### 1. What is Keploy?
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
id: integrations-pr-agent
3+
title: Integrations & Connected Tools
4+
sidebar_label: Integrations & Connected Tools
5+
description: See which platforms Keploy integrates with for automated PR testing.
6+
tags:
7+
- integrations
8+
- github
9+
- PR agent
10+
---
11+
12+
# 🔗 Integrations with SCM
13+
14+
Keploy’s PR Agent helps automate code reviews, testing, and feedback—right where you work.
15+
16+
## ✅ Currently Supported
17+
18+
**GitHub:**
19+
Our PR Agent seamlessly integrates with GitHub repositories for test automation, coverage checks, and intelligent feedback on your pull requests.
20+
21+
## 💡 Need Support for Another Platform?
22+
23+
Want Keploy’s PR Agent on GitLab, Bitbucket, or another platform?
24+
25+
[Reach out to our team!](mailto:support@keploy.io)
26+
27+
We’re always open to feedback and requests as we expand our integration support.
28+
29+
**More integrations are coming soon—stay tuned!**

0 commit comments

Comments
 (0)