Skip to content

Commit 6f07c2b

Browse files
authored
chore: atg operations (#587)
1 parent 02759a9 commit 6f07c2b

File tree

9 files changed

+177
-73
lines changed

9 files changed

+177
-73
lines changed

README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,6 @@ The command starts a local development server and opens a browser window.
7878

7979
> 💡 **Tip:** After running `npm install`, use `npm start` to preview changes live at `http://localhost:3000/`.
8080
81-
8281
## Running Vale Locally for Documentation Linting
8382

8483
To help maintain consistency in our documentation, we use Vale, a syntax-aware linter that checks for spelling, grammar, and style issues.

STYLE.md

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Style Guidance
22

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).
44

55
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/).
66

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

20-
**Correct:**
20+
**Correct:**
21+
2122
> “Next, Normalise the Test case on the Test run details page.”
2223
23-
**Incorrect:**
24+
**Incorrect:**
25+
2426
> “Next, normalise the test case on the test run details.”
2527
2628
---
@@ -30,9 +32,11 @@ To reduce confusion, **always capitalize Keploy-specific terms** when referring
3032
Use **sentence case** for all titles and headings. This means only the **first word** and **proper nouns** are capitalized.
3133

3234
✅ Correct:
35+
3336
> How to get started with Keploy
3437
3538
❌ Incorrect:
39+
3640
> How To Get Started With Keploy
3741
3842
---
@@ -43,10 +47,12 @@ Use **infinitive verb forms** (e.g., "to install", "to create", "to configure")
4347
This improves searchability and aligns with common SEO practices.
4448

4549
✅ Correct:
50+
4651
> Install Keploy
4752
> Create test cases
4853
4954
❌ Incorrect:
55+
5056
> Installing Keploy
5157
> Creating test cases
5258
@@ -55,13 +61,15 @@ This improves searchability and aligns with common SEO practices.
5561
### 🧮 En Dashes in Ranges
5662

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

6066
✅ Correct:
67+
6168
- 5–10 GB
6269
- 5 to 10 GB
6370

6471
❌ Incorrect:
72+
6573
- from 5-10 GB
6674
- 5–10 GB and 10 to 20 MB (mixed style)
6775

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

7482
✅ Correct:
83+
7584
> Keploy records the API calls and generates test cases.
7685
7786
❌ Incorrect:
87+
7888
> The API calls are recorded and test cases are generated by Keploy.
7989
8090
---
8191

8292
### 🌍 Write for Global Readability
8393

8494
Use clear, simple, and **inclusive language**:
95+
8596
- Avoid jargon or unexplained acronyms.
8697
- Provide context for technical terms.
8798
- Prefer short, direct sentences.
8899

89100
✅ Better:
101+
90102
> After installing Go, use the following command to run Keploy.
91103
92104
❌ Confusing:
105+
93106
> Assuming GOPATH is set and your binaries are globally linked, execute Keploy.
94107
95108
---
@@ -98,10 +111,10 @@ Use clear, simple, and **inclusive language**:
98111

99112
- Wrap inline code using backticks: \`like this\`
100113
- Use triple backticks for multi-line code blocks:
101-
\`\`\`bash
102-
npm install
103-
npm run serve
104-
\`\`\`
114+
\`\`\`bash
115+
npm install
116+
npm run serve
117+
\`\`\`
105118
- Add comments in code examples where needed for clarity.
106119

107120
---
@@ -118,4 +131,3 @@ Use clear, simple, and **inclusive language**:
118131
---
119132

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

src/components/KeployCloud.js

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
import React from "react";
22

33
export const KeployCloud = () => {
4-
54
return (
65
<section
76
id="cloud"
@@ -10,7 +9,7 @@ export const KeployCloud = () => {
109
<div className="max-w-3xl mx-auto prose prose-orange">
1110
<h1> Question? 🤔💭</h1>
1211
<p className="my-3 block">
13-
For any support please{" "}
12+
For any support please{" "}
1413
<a
1514
href="https://join.slack.com/t/keploy/shared_invite/zt-357qqm9b5-PbZRVu3Yt2rJIa6ofrwWNg"
1615
className="text-orange-500 underline hover:text-orange-400"

static/img/share.png

388 KB
Loading

versioned_docs/version-3.0.0/running-keploy/api-testing-tool-ai-powered.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -19,34 +19,34 @@ keywords:
1919
- postman test suite
2020
- no code testing
2121
---
22-
## 🤖 Why AI for API Testing?
2322

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

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

3131
## 💥 Why Keploy? Not Other AI Testing Tools
3232

33-
| Capability | Keploy | Most AI Tools |
34-
|---------------------------------------------------|-----------------------------------------------------------------|-------------------------------------------------|
35-
| 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 |
43-
33+
| Capability | Keploy | Most AI Tools |
34+
| ------------------------------------------------------ | ---------------------------------------------------------------- | --------------------------------------------- |
35+
| 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 |
4443

4544
## 🚀 Keploy's API Test Generator
4645

4746
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.
4847

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

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

6566
## 🛠️ 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:
6767

68-
| Integration Method | When to Use | How Keploy Works? |
69-
|-----------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------|
70-
| **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:
7369

70+
| Integration Method | When to Use | How Keploy Works? |
71+
| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
72+
| **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. |
7475

7576
## ✨ Key Features
7677

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

9091
## 🚀 Try It Out
9192

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
9394

94-
- Add your API input or select a sample application (**try demo**)
95+
- Add your API input or select a sample application (**try demo**)
9596

9697
- Generate and review your test suite
9798

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.
100100

101101
## 🔒 Security & Compliance
102102

0 commit comments

Comments
 (0)