Skip to content

Commit e41c3b8

Browse files
nehagupTvisharajiK
andauthored
feat: adding atg public docs for fix with ai (#588)
* docs: adding atg public docs for installation and explanation Signed-off-by: Neha Gupta <gneha21@yahoo.in> * docs: adding atg public docs for fix with ai Signed-off-by: Neha Gupta <gneha21@yahoo.in> * chore: atg operations (#587) * chore: atg operations (#587) * docs: adding atg public docs for fix with ai Signed-off-by: Neha Gupta <gneha21@yahoo.in> --------- Signed-off-by: Neha Gupta <gneha21@yahoo.in> Co-authored-by: Tvisha <tvisha.raji@keploy.io>
1 parent 6f07c2b commit e41c3b8

File tree

3 files changed

+67
-7
lines changed

3 files changed

+67
-7
lines changed

docusaurus.config.js

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -119,18 +119,18 @@ module.exports = {
119119
label: "Products",
120120
position: "left",
121121
items: [
122-
{
123-
label: "Unit Testing",
124-
to: "/running-keploy/utg-pr-agent/",
125-
},
126122
{
127123
label: "Integration Testing",
128124
to: "/keploy-explained/introduction",
129125
},
130126
{
131-
label: "API Testing",
127+
label: "API Testing (AI)",
132128
to: "/running-keploy/api-test-generator",
133129
},
130+
{
131+
label: "Unit Testing",
132+
to: "/running-keploy/utg-pr-agent",
133+
},
134134
],
135135
},
136136
{
@@ -141,7 +141,7 @@ module.exports = {
141141
href: "https://keploy.io/blog/technology",
142142
},
143143
{
144-
label: "Communtity Articles",
144+
label: "Community Articles",
145145
href: "https://keploy.io/blog/community",
146146
},
147147
{
Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
id: self-healing-ai-api-tests
3+
title: Self-Healing API Tests
4+
sidebar_label: Self-Heal API Tests
5+
description: Automatically update failing API test cases using Keploy AI.
6+
tags:
7+
- API testing
8+
- test automation
9+
- AI testing
10+
- self-healing
11+
- flaky test repair
12+
keywords:
13+
- fix failing tests
14+
- heal test cases
15+
- keploy ai testing
16+
---
17+
18+
Keploy can automatically fix failing test cases using its built-in AI engine. This is useful when:
19+
20+
- Your API responses have changed slightly (e.g. new fields, formats)
21+
- Assertion mismatches are minor
22+
- You want to fix many tests without editing them one-by-one
23+
24+
### 🔧 How to Use Self-Healing
25+
26+
1. **Go to the Test Report**
27+
28+
- Navigate to the test report where failures are listed.
29+
30+
2. **Click on a Failed Test**
31+
32+
- Open the specific failing test case you'd like to fix.
33+
34+
3. **Click "Fix with AI"**
35+
36+
- This will trigger Keploy AI to update the assertions based on the current API response.
37+
38+
4. _(Optional)_ **Add Context**
39+
40+
- You can provide hints or expectations to help the AI fix it more precisely.
41+
42+
5. _(Optional)_ **Bulk Fix**
43+
44+
- From the **Test Suites** page, select multiple suites and click **"Fix with AI"** to heal them all in one go.
45+
46+
6. **Wait for AI to Heal**
47+
48+
- The process may take a few seconds to complete.
49+
50+
7. **Find Updated Tests**
51+
- Revisit the **Test Suites** page to view the newly healed tests.
52+
53+
### ✅ Best Practices
54+
55+
- Use AI healing after any significant backend changes.
56+
- Review the updated assertions to ensure correctness.
57+
- Combine healing with test deduplication to keep your suite clean.
58+
59+
[//]: # "You can read more on [Test Reports](/docs/running-keploy/review-and-improve-ai-generated-tests) or [Running Tests](/docs/running-keploy/run-ai-generated-api-tests)."

versioned_sidebars/version-3.0.0-sidebars.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,8 @@
2121
"collapsed": false,
2222
"items": [
2323
"running-keploy/review-and-improve-ai-generated-tests",
24-
"running-keploy/share-tests"
24+
"running-keploy/share-tests",
25+
"running-keploy/self-healing-ai-api-tests"
2526
]
2627
},
2728
{

0 commit comments

Comments
 (0)