You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: STYLE.md
+21-9Lines changed: 21 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Style Guidance
2
2
3
-
Keploy documentation generally follows the [Google Developer Documentation Style Guide](https://developers.google.com/style).
3
+
Keploy documentation generally follows the [Google Developer Documentation Style Guide](https://developers.google.com/style).
4
4
5
5
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/).
6
6
@@ -17,10 +17,12 @@ The following are Keploy-specific rules that override or expand on the Google an
17
17
Some of Keploy’s core terms may also exist as generic terms in software or technical contexts.
18
18
To reduce confusion, **always capitalize Keploy-specific terms** when referring to features or platform components. Generic usage should be lowercase and used sparingly.
19
19
20
-
✅ **Correct:**
20
+
✅ **Correct:**
21
+
21
22
> “Next, Normalise the Test case on the Test run details page.”
22
23
23
-
❌ **Incorrect:**
24
+
❌ **Incorrect:**
25
+
24
26
> “Next, normalise the test case on the test run details.”
25
27
26
28
---
@@ -30,9 +32,11 @@ To reduce confusion, **always capitalize Keploy-specific terms** when referring
30
32
Use **sentence case** for all titles and headings. This means only the **first word** and **proper nouns** are capitalized.
| Validated test execution | ✅ Runs and verifies each test before saving | ❌ Often generates unverified or broken tests |
36
+
| Full API flow coverage<br/> (Create → Update → Delete) | ✅ Supports complete multi-step flows | ❌ Focuses on isolated requests |
37
+
| Edge case & negative test generation | ✅ Auto-detects and generates edge cases | ⚠️ Limited or requires manual prompting |
38
+
| Replay across environments | ✅ Runs tests in dev, staging, CI with environment switching | ⚠️ Often environment-specific or hard-coded |
39
+
| Self-healing on API changes | ✅ Updates tests if API schema changes | ❌ No maintenance support |
40
+
| Flaky test detection | ✅ Re-runs tests to detect instability | ❌ Not supported |
41
+
| Collaboration & governance features | ✅ RBAC, audit trails, tagging, Git sync | ❌ Basic or missing |
42
+
| Works from real traffic or browser flows | ✅ Converts real traffic or frontend API interactions into tests | ⚠️ Most rely only on static specs |
44
43
45
44
## 🚀 Keploy's API Test Generator
46
45
47
46
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.
48
47
49
48
It supports:
49
+
50
50
- Generate tests from OpenAPI, Postman, or curl commands
51
51
- Run tests in any environment (dev, staging, CI)
52
52
- Edit, group, or delete test cases in the UI
@@ -55,6 +55,7 @@ It supports:
55
55
- Record API flows via Keploy’s Chrome extension
56
56
57
57
Every test includes:
58
+
58
59
- Accurate assertions based on real responses
59
60
- Full lifecycle coverage (create → mutate → delete)
60
61
- Deduplication and flaky test detection
@@ -63,14 +64,14 @@ Every test includes:
63
64
Whether you're a developer, SDET, or QA manager — Keploy helps you increase test coverage, reduce test debt, and ensure reliable releases across environments.
64
65
65
66
## 🛠️ How It Works
66
-
Keploy supports multiple ways to generate test cases depending on the API access method and input format. Choose the one that fits your workflow:
67
67
68
-
| 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. |
71
-
|**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. |
72
-
|**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. |
68
+
Keploy supports multiple ways to generate test cases depending on the API access method and input format. Choose the one that fits your workflow:
73
69
70
+
| 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. |
73
+
|**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. |
74
+
|**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. |
74
75
75
76
## ✨ Key Features
76
77
@@ -89,14 +90,13 @@ Keploy supports multiple ways to generate test cases depending on the API access
89
90
90
91
## 🚀 Try It Out
91
92
92
-
- Go to [keploy console](https://app.keploy.io/api-testing/generate)API Test Generator
93
+
- Go to [keploy console](https://app.keploy.io/api-testing/generate) API Test Generator
93
94
94
-
- Add your API input or select a sample application (**try demo**)
95
+
- Add your API input or select a sample application (**try demo**)
95
96
96
97
- Generate and review your test suite
97
98
98
-
- You can run tests instantly, or export them into your pipeline.
99
-
99
+
- You can run tests instantly, or export them into your pipeline.
0 commit comments