Skip to content
Merged
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
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,6 @@ The command starts a local development server and opens a browser window.

> 💡 **Tip:** After running `npm install`, use `npm start` to preview changes live at `http://localhost:3000/`.


## Running Vale Locally for Documentation Linting

To help maintain consistency in our documentation, we use Vale, a syntax-aware linter that checks for spelling, grammar, and style issues.
Expand Down
30 changes: 21 additions & 9 deletions STYLE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Style Guidance

Keploy documentation generally follows the [Google Developer Documentation Style Guide](https://developers.google.com/style).
Keploy documentation generally follows the [Google Developer Documentation Style Guide](https://developers.google.com/style).

When the Google guide does not address a specific topic, we defer to the [Microsoft Writing Style Guide](https://docs.microsoft.com/en-us/style-guide/welcome/).

Expand All @@ -17,10 +17,12 @@ The following are Keploy-specific rules that override or expand on the Google an
Some of Keploy’s core terms may also exist as generic terms in software or technical contexts.
To reduce confusion, **always capitalize Keploy-specific terms** when referring to features or platform components. Generic usage should be lowercase and used sparingly.

✅ **Correct:**
✅ **Correct:**

> “Next, Normalise the Test case on the Test run details page.”

❌ **Incorrect:**
❌ **Incorrect:**

> “Next, normalise the test case on the test run details.”

---
Expand All @@ -30,9 +32,11 @@ To reduce confusion, **always capitalize Keploy-specific terms** when referring
Use **sentence case** for all titles and headings. This means only the **first word** and **proper nouns** are capitalized.

✅ Correct:

> How to get started with Keploy

❌ Incorrect:

> How To Get Started With Keploy

---
Expand All @@ -43,10 +47,12 @@ Use **infinitive verb forms** (e.g., "to install", "to create", "to configure")
This improves searchability and aligns with common SEO practices.

✅ Correct:

> Install Keploy
> Create test cases

❌ Incorrect:

> Installing Keploy
> Creating test cases

Expand All @@ -55,13 +61,15 @@ This improves searchability and aligns with common SEO practices.
### 🧮 En Dashes in Ranges

Use **en dashes (–)** to indicate numeric ranges. Do **not** mix styles or use hyphens inconsistently.
You may also use words like *from*, *to*, or *through* — but be consistent throughout the doc.
You may also use words like _from_, _to_, or _through_ — but be consistent throughout the doc.

✅ Correct:

- 5–10 GB
- 5 to 10 GB

❌ Incorrect:

- from 5-10 GB
- 5–10 GB and 10 to 20 MB (mixed style)

Expand All @@ -72,24 +80,29 @@ You may also use words like *from*, *to*, or *through* — but be consistent thr
Use **active voice** instead of passive voice to improve clarity and readability.

✅ Correct:

> Keploy records the API calls and generates test cases.

❌ Incorrect:

> The API calls are recorded and test cases are generated by Keploy.

---

### 🌍 Write for Global Readability

Use clear, simple, and **inclusive language**:

- Avoid jargon or unexplained acronyms.
- Provide context for technical terms.
- Prefer short, direct sentences.

✅ Better:

> After installing Go, use the following command to run Keploy.

❌ Confusing:

> Assuming GOPATH is set and your binaries are globally linked, execute Keploy.

---
Expand All @@ -98,10 +111,10 @@ Use clear, simple, and **inclusive language**:

- Wrap inline code using backticks: \`like this\`
- Use triple backticks for multi-line code blocks:
\`\`\`bash
npm install
npm run serve
\`\`\`
\`\`\`bash
npm install
npm run serve
\`\`\`
- Add comments in code examples where needed for clarity.

---
Expand All @@ -118,4 +131,3 @@ Use clear, simple, and **inclusive language**:
---

> ✨ _Consistency leads to clarity. Let’s keep Keploy documentation clean, helpful, and easy to follow._

3 changes: 1 addition & 2 deletions src/components/KeployCloud.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import React from "react";

export const KeployCloud = () => {

return (
<section
id="cloud"
Expand All @@ -10,7 +9,7 @@ export const KeployCloud = () => {
<div className="max-w-3xl mx-auto prose prose-orange">
<h1> Question? 🤔💭</h1>
<p className="my-3 block">
For any support please{" "}
For any support please{" "}
<a
href="https://join.slack.com/t/keploy/shared_invite/zt-357qqm9b5-PbZRVu3Yt2rJIa6ofrwWNg"
className="text-orange-500 underline hover:text-orange-400"
Expand Down
Binary file added static/img/share.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -19,34 +19,34 @@ keywords:
- postman test suite
- no code testing
---
## 🤖 Why AI for API Testing?

| API Testing Challenge | ROI & Impact |
|-------------------------------------------------|---------------------------------------------------------------------------------------------------|
| Edge-case, bugs, coverage flows gets missed | Higher test coverage across CRUD and failure scenarios |
| APIs change frequently, leading to broken tests | Self-healing keeps tests even when APIs evolves |
| 30–50% of time spent writing tests | 50–80% reduction in test creation <br/> Covers more edge cases within limited resources, time |
## 🤖 Why AI for API Testing?

| API Testing Challenge | ROI & Impact |
| ----------------------------------------------- | --------------------------------------------------------------------------------------------- |
| Edge-case, bugs, coverage flows gets missed | Higher test coverage across CRUD and failure scenarios |
| APIs change frequently, leading to broken tests | Self-healing keeps tests even when APIs evolves |
| 30–50% of time spent writing tests | 50–80% reduction in test creation <br/> Covers more edge cases within limited resources, time |

## 💥 Why Keploy? Not Other AI Testing Tools

| Capability | Keploy | Most AI Tools |
|---------------------------------------------------|-----------------------------------------------------------------|-------------------------------------------------|
| Validated test execution | ✅ Runs and verifies each test before saving | ❌ Often generates unverified or broken tests |
| Full API flow coverage<br/> (Create → Update → Delete) | ✅ Supports complete multi-step flows | ❌ Focuses on isolated requests |
| Edge case & negative test generation | ✅ Auto-detects and generates edge cases | ⚠️ Limited or requires manual prompting |
| Replay across environments | ✅ Runs tests in dev, staging, CI with environment switching | ⚠️ Often environment-specific or hard-coded |
| Self-healing on API changes | ✅ Updates tests if API schema changes | ❌ No maintenance support |
| Flaky test detection | ✅ Re-runs tests to detect instability | ❌ Not supported |
| Collaboration & governance features | ✅ RBAC, audit trails, tagging, Git sync | ❌ Basic or missing |
| Works from real traffic or browser flows | ✅ Converts real traffic or frontend API interactions into tests | ⚠️ Most rely only on static specs |

| Capability | Keploy | Most AI Tools |
| ------------------------------------------------------ | ---------------------------------------------------------------- | --------------------------------------------- |
| Validated test execution | ✅ Runs and verifies each test before saving | ❌ Often generates unverified or broken tests |
| Full API flow coverage<br/> (Create → Update → Delete) | ✅ Supports complete multi-step flows | ❌ Focuses on isolated requests |
| Edge case & negative test generation | ✅ Auto-detects and generates edge cases | ⚠️ Limited or requires manual prompting |
| Replay across environments | ✅ Runs tests in dev, staging, CI with environment switching | ⚠️ Often environment-specific or hard-coded |
| Self-healing on API changes | ✅ Updates tests if API schema changes | ❌ No maintenance support |
| Flaky test detection | ✅ Re-runs tests to detect instability | ❌ Not supported |
| Collaboration & governance features | ✅ RBAC, audit trails, tagging, Git sync | ❌ Basic or missing |
| Works from real traffic or browser flows | ✅ Converts real traffic or frontend API interactions into tests | ⚠️ Most rely only on static specs |

## 🚀 Keploy's API Test Generator

AI-powered testing engine that turns your API specs or traffic into stable, end-to-end test suites — no scripts, mocks, or manual setup required.

It supports:

- Generate tests from OpenAPI, Postman, or curl commands
- Run tests in any environment (dev, staging, CI)
- Edit, group, or delete test cases in the UI
Expand All @@ -55,6 +55,7 @@ It supports:
- Record API flows via Keploy’s Chrome extension

Every test includes:

- Accurate assertions based on real responses
- Full lifecycle coverage (create → mutate → delete)
- Deduplication and flaky test detection
Expand All @@ -63,14 +64,14 @@ Every test includes:
Whether you're a developer, SDET, or QA manager — Keploy helps you increase test coverage, reduce test debt, and ensure reliable releases across environments.

## 🛠️ How It Works
Keploy supports multiple ways to generate test cases depending on the API access method and input format. Choose the one that fits your workflow:

| Integration Method | When to Use | How Keploy Works? |
|-----------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------|
| **Paste API Curls, Postman Collection, Schema/Swagger**<br/>[Try Now](/docs/running-keploy/generate-api-tests-using-ai) | You have OpenAPI/Swagger (YAML/JSON), Postman collection/curl, and a live public endpoint | Keploy hits multiple API cases to given endpoint and generate stable, validated tests with assertions. |
| **Record via Keploy Chrome Extension**<br/> | You don’t have specs but can interact with a web app for recording | Keploy captures real API calls made during UI actions and generates test cases with assertions. Adds edge cases and flow coverage automatically. |
| **Use Keploy Local Agent** <br/>[Try Now](/docs/running-keploy/generate-api-tests-using-ai) | Your APIs are private or behind a firewall | Install the agent locally to securely test internal APIs without exposing them. No code changes required. |
Keploy supports multiple ways to generate test cases depending on the API access method and input format. Choose the one that fits your workflow:

| Integration Method | When to Use | How Keploy Works? |
| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| **Paste API Curls, Postman Collection, Schema/Swagger**<br/>[Try Now](/docs/running-keploy/generate-api-tests-using-ai) | You have OpenAPI/Swagger (YAML/JSON), Postman collection/curl, and a live public endpoint | Keploy hits multiple API cases to given endpoint and generate stable, validated tests with assertions. |
| **Record via Keploy Chrome Extension**<br/> | You don’t have specs but can interact with a web app for recording | Keploy captures real API calls made during UI actions and generates test cases with assertions. Adds edge cases and flow coverage automatically. |
| **Use Keploy Local Agent** <br/>[Try Now](/docs/running-keploy/generate-api-tests-using-ai) | Your APIs are private or behind a firewall | Install the agent locally to securely test internal APIs without exposing them. No code changes required. |

## ✨ Key Features

Expand All @@ -89,14 +90,13 @@ Keploy supports multiple ways to generate test cases depending on the API access

## 🚀 Try It Out

- Go to [keploy console](https://app.keploy.io/api-testing/generate) API Test Generator
- Go to [keploy console](https://app.keploy.io/api-testing/generate) API Test Generator

- Add your API input or select a sample application (**try demo**)
- Add your API input or select a sample application (**try demo**)

- Generate and review your test suite

- You can run tests instantly, or export them into your pipeline.

- You can run tests instantly, or export them into your pipeline.

## 🔒 Security & Compliance

Expand Down
Loading