From f34e09b91f1afb4a5634781ceb3a4af529d51e0e Mon Sep 17 00:00:00 2001 From: dhananjay6561 Date: Fri, 7 Aug 2026 15:25:19 +0530 Subject: [PATCH 01/26] fix(docs): add image to Article schema (A1) DocItem computed socialImage but never included it in the Article/ TechArticle JSON-LD, so every doc page emitted an Article without the required 'image' field -> ~146 pages flagged invalid structured data. Add image to articleSchema, falling back to the site-wide default social card (the same 1200x630 og:image from docusaurus.config.js) when a doc sets no front-matter image. Signed-off-by: dhananjay6561 --- src/theme/DocItem/index.js | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/theme/DocItem/index.js b/src/theme/DocItem/index.js index 9d09f48a1..153701a1c 100644 --- a/src/theme/DocItem/index.js +++ b/src/theme/DocItem/index.js @@ -147,6 +147,10 @@ export default function DocItem(props) { const socialImage = image ? toAbsoluteUrl(siteConfig?.url, imageWithBaseUrl) : null; + // Article schema requires an `image`; fall back to the site-wide default + // social card (the same 1200x630 og:image set in docusaurus.config.js) when + // a doc has no front-matter image, so every Article carries a valid image. + const articleImage = socialImage || "https://keploy.io/images/keploy-hero.png"; const normalizedMetaKeywords = Array.isArray(metaKeywords) ? metaKeywords.join(", ") : metaKeywords; @@ -196,6 +200,7 @@ export default function DocItem(props) { "@type": schemaType, headline: title, description, + image: [articleImage], ...(modifiedTime ? {dateModified: modifiedTime} : {}), // datePublished falls back to the last-modified time so every doc // carries a freshness signal even when front matter omits `date`. From 88f8864fff9efd313cd59acf37c507e9a79021c8 Mon Sep 17 00:00:00 2001 From: dhananjay6561 Date: Fri, 7 Aug 2026 15:25:30 +0530 Subject: [PATCH 02/26] fix(docs): differentiate page title from h1 (A2) The swizzled DocItem set {title}, identical to the on-page

(also the doc title) -> SEMrush 'Duplicate content in h1 and title' on 124 pages. Append ' | Keploy Docs' so the title differs from the h1. Signed-off-by: dhananjay6561 --- src/theme/DocItem/index.js | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/theme/DocItem/index.js b/src/theme/DocItem/index.js index 153701a1c..caa8b00a1 100644 --- a/src/theme/DocItem/index.js +++ b/src/theme/DocItem/index.js @@ -244,7 +244,10 @@ export default function DocItem(props) { return ( <> - {title} + {/* Suffix differentiates the from the on-page <h1> (which is + also `title`), clearing SEMrush "Duplicate content in h1 and title" + across all doc pages. */} + <title>{`${title} | Keploy Docs`} {description && } {normalizedMetaKeywords && ( From 52568dfac4503d41be7a3e818371a0898b4f6fe1 Mon Sep 17 00:00:00 2001 From: dhananjay6561 Date: Fri, 7 Aug 2026 15:32:25 +0530 Subject: [PATCH 03/26] fix(docs): add alt text to images missing it (A8) 13 images across 8 doc pages (glossary GIFs + running-keploy screenshots) had no alt attribute -> SEMrush 'Missing ALT' + weaker AI/accessibility extraction. Add descriptive alt to each. utg-vscode-extension from the audit list no longer exists on main, so it is not included. Signed-off-by: dhananjay6561 --- .../concepts/reference/glossary/code-coverage.md | 2 +- .../concepts/reference/glossary/end-to-end-testing.md | 2 +- .../reference/glossary/microservice-testing.md | 2 +- .../version-4.0.0/concepts/reference/glossary/mocks.md | 2 +- .../version-4.0.0/concepts/reference/glossary/stubs.md | 2 +- .../running-keploy/api-testing-functions.md | 4 ++-- .../running-keploy/api-testing-variables.md | 4 ++-- .../version-4.0.0/running-keploy/utg-pr-agent.md | 10 +++++----- 8 files changed, 14 insertions(+), 14 deletions(-) diff --git a/versioned_docs/version-4.0.0/concepts/reference/glossary/code-coverage.md b/versioned_docs/version-4.0.0/concepts/reference/glossary/code-coverage.md index 63d9e6641..9b2b2a6f0 100644 --- a/versioned_docs/version-4.0.0/concepts/reference/glossary/code-coverage.md +++ b/versioned_docs/version-4.0.0/concepts/reference/glossary/code-coverage.md @@ -41,7 +41,7 @@ It's analysis provides several benefits: Keploy has native integrations with your unit-testing libraries like go-test, jUnit, jest, pyTest. Keploy gives combined test-coverage and can also be integrated in existing CI pipelines easily within go-test, jUnit, jest, pyTest workflows. - +Keploy replaying recorded test cases to measure code coverage By generating additional tests that exercise different parts of your codebase, you can increase the percentage of code that is covered by your tests. For example, in case of NodeJS application you can use Jest. Jest provides a built-in code coverage tool that can help you measure the effectiveness of your tests and identify areas of the code that need additional testing. By adding Keploy SDK with Jest, you can easily generate test cases and increase your code coverage. Let's create a `Keploy.test.js` diff --git a/versioned_docs/version-4.0.0/concepts/reference/glossary/end-to-end-testing.md b/versioned_docs/version-4.0.0/concepts/reference/glossary/end-to-end-testing.md index 9f8d8b26e..83dd711af 100644 --- a/versioned_docs/version-4.0.0/concepts/reference/glossary/end-to-end-testing.md +++ b/versioned_docs/version-4.0.0/concepts/reference/glossary/end-to-end-testing.md @@ -45,7 +45,7 @@ Despite the challenges, E2E testing is an important part of the software develop Keploy generate E2E API tests with built-in-mocks or stubs by recording your application network calls making your testing process not only faster than unit tests but also incredibly efficient. - +Keploy recording end-to-end API test cases from live application traffic ### How Keploy works? diff --git a/versioned_docs/version-4.0.0/concepts/reference/glossary/microservice-testing.md b/versioned_docs/version-4.0.0/concepts/reference/glossary/microservice-testing.md index 96e839c32..d59573888 100644 --- a/versioned_docs/version-4.0.0/concepts/reference/glossary/microservice-testing.md +++ b/versioned_docs/version-4.0.0/concepts/reference/glossary/microservice-testing.md @@ -41,7 +41,7 @@ Microservice testing is the process of validating individual components of a mic ## Overcoming Challenges with Keploy Keploy is an innovative testing tool designed to address many of the challenges associated with microservices testing. Here's how it helps: - +Keploy recording and replaying API calls across microservices
- **Automated Test Case Generation**: Keploy can generate test cases by recording your application's network calls. This automation significantly reduces the time and effort required to create comprehensive test suites. diff --git a/versioned_docs/version-4.0.0/concepts/reference/glossary/mocks.md b/versioned_docs/version-4.0.0/concepts/reference/glossary/mocks.md index ae6136fb3..f9c7dd5d3 100644 --- a/versioned_docs/version-4.0.0/concepts/reference/glossary/mocks.md +++ b/versioned_docs/version-4.0.0/concepts/reference/glossary/mocks.md @@ -36,6 +36,6 @@ Data mocks refer to the synthetic data that mimics real-world datasets, which is Keploy can generate dependency mocks in addition to the testcases by recording your application network calls making your testing process not only faster than unit tests but also incredibly efficient. - +Keploy recording API calls and replaying them using generated mocks Since these data mocks are generated based on the real-time capturing of API calls from your application, they will be from real-world scenarios. This can help to ensure that the data mocks are accurate and that it represents the real data as closely as possible. As well as, it makes the data maintenance process easier by providing a same environment for testing. This can help to identify the source of bugs more easily. diff --git a/versioned_docs/version-4.0.0/concepts/reference/glossary/stubs.md b/versioned_docs/version-4.0.0/concepts/reference/glossary/stubs.md index 29c3b5fda..7a6baf7b2 100644 --- a/versioned_docs/version-4.0.0/concepts/reference/glossary/stubs.md +++ b/versioned_docs/version-4.0.0/concepts/reference/glossary/stubs.md @@ -50,6 +50,6 @@ Overall, stubs are a valuable tool for software development and testing. They ca Keploy can generate dependency stubs in addition to the testcases by recording your application network calls making your testing process not only faster than unit tests but also incredibly efficient. - +Keploy recording API calls and replaying them using generated stubs Since the data stubs are generated based on the real-time capturing of API calls from your application, they will be from real-world scenarios. This can help to ensure that the mock data is accurate and that it represents the real data as closely as possible. As well as, it makes the data maintenance process easier by providing a same environment for testing. This can help to identify the source of bugs more easily. diff --git a/versioned_docs/version-4.0.0/running-keploy/api-testing-functions.md b/versioned_docs/version-4.0.0/running-keploy/api-testing-functions.md index 5c0d4066d..0a795f929 100644 --- a/versioned_docs/version-4.0.0/running-keploy/api-testing-functions.md +++ b/versioned_docs/version-4.0.0/running-keploy/api-testing-functions.md @@ -20,14 +20,14 @@ Assertions define the **"Pass/Fail"** criteria for your tests. While standard ch ### 1. Selecting Fields to Assert Choose specifically which parts of a JSON response Keploy should validate during a replay. - +Schema assertion configuration selecting response fields on a Keploy API test **Example Context:** In this window, we are targeting a `GET` request on the `/visits/-1` endpoint that expects a `400` status code. Under **Response Fields**, specific keys like `className` and `exMessage` are selected. Toggling these ensures Keploy validates that these fields are returned as the correct data type (strings) during every replay. ### 2. Multi-Type Assertions Stack different assertion types, such as verifying a status code while simultaneously checking if a specific field contains a certain value. - +Multiple assertion types applied to a single Keploy API test **Example Context:** This setup enforces two rules simultaneously: 1. **Status Code**: Validates that the server returns a `201` (Created). diff --git a/versioned_docs/version-4.0.0/running-keploy/api-testing-variables.md b/versioned_docs/version-4.0.0/running-keploy/api-testing-variables.md index 2e6dad6ce..6512e55f5 100644 --- a/versioned_docs/version-4.0.0/running-keploy/api-testing-variables.md +++ b/versioned_docs/version-4.0.0/running-keploy/api-testing-variables.md @@ -32,13 +32,13 @@ To reuse data, you define a mapping that tells Keploy exactly where to look in a ### 2. Injection into Requests Injection allows you to replace static values with dynamic variables, ensuring your tests remain flexible across different environments and data states. - +Injecting a dynamic variable into a Keploy API test request **Example Context:** This view shows the **Request Details** for an API call to the `/owners` endpoint. By defining the method (e.g., **POST**), you can then use placeholders like `{{owner_id}}` in the URL path or body. Keploy will automatically swap the placeholder with the actual value captured during test execution. ### 3. Global Variable Management Global variables serve as the centralized source of truth for your testing environment. - +Configuring global variables in Keploy API testing **Example Context:** The **Global Variables** dashboard allows you to manage workspace-wide data. This includes static entries like the **base URL** and dynamic **Global Custom Functions**. For instance, `generateCompanyId()` is a function that returns a unique string starting with `COMP_` followed by a timestamp, ensuring unique identifiers for every test run. \ No newline at end of file diff --git a/versioned_docs/version-4.0.0/running-keploy/utg-pr-agent.md b/versioned_docs/version-4.0.0/running-keploy/utg-pr-agent.md index 0bde9477e..beff70a8e 100644 --- a/versioned_docs/version-4.0.0/running-keploy/utg-pr-agent.md +++ b/versioned_docs/version-4.0.0/running-keploy/utg-pr-agent.md @@ -33,7 +33,7 @@ Follow the steps below to get started with the Keploy PR Agent on your GitHub re - Visit [Github Marketplace](https://github.com/marketplace/keploy) - +Keploy GitHub App listing on the GitHub Marketplace Click on **Add**. @@ -43,7 +43,7 @@ Choose: - **All repositories** if you want the functionality across your GitHub organization. - Authorize the app to complete the installation. - + Choosing repositories while installing the Keploy GitHub App ### Step 2. Make a Code Change and Open a Pull Request @@ -53,7 +53,7 @@ Once the app is installed: - Push your changes and **create a pull request (PR)** as usual. - The **Keploy PR Agent** will automatically detect the changes and leave a comment on the PR. - + Keploy PR Agent leaving an automated comment on a pull request ### Step 3. Trigger Unit Test Generation @@ -63,7 +63,7 @@ In the PR comment left by Keploy: - You will be redirected to the Keploy service, where the unit test generation process begins. - The PR Agent uses code semantics and the power of LLMs to understand your code changes and generate meaningful unit tests. - + Keploy service generating unit tests from the pull request changes ### Step 4. View the Generated Tests and Summary @@ -74,7 +74,7 @@ Once the process is complete: - All the **unit test files** generated for your recent changes. - A **test summary** presented in a **clean tabular format** showing: - File names - Number of test cases - Coverage details - Edge cases handled (if any) - + Pull request comment showing generated unit test files and a test summary table You can review, modify, or directly merge the PR with complete confidence that your changes are well-tested. With Keploy PR Agent, testing is no longer a bottleneck - it’s built right into your workflow. From 23c9c940b2e3181a41e6c32f80a721d52ea6596f Mon Sep 17 00:00:00 2001 From: dhananjay6561 Date: Fri, 7 Aug 2026 15:32:33 +0530 Subject: [PATCH 04/26] style(docs): prettier formatting on api-testing-functions/variables Pre-existing whitespace/list-indent/final-newline issues in these two files (unrelated to the alt fix) would fail the prettier CI check once the files are touched. Apply prettier so the PR is clean. Signed-off-by: dhananjay6561 --- .../running-keploy/api-testing-functions.md | 10 ++++++---- .../running-keploy/api-testing-variables.md | 14 ++++++++------ 2 files changed, 14 insertions(+), 10 deletions(-) diff --git a/versioned_docs/version-4.0.0/running-keploy/api-testing-functions.md b/versioned_docs/version-4.0.0/running-keploy/api-testing-functions.md index 0a795f929..5adebce6f 100644 --- a/versioned_docs/version-4.0.0/running-keploy/api-testing-functions.md +++ b/versioned_docs/version-4.0.0/running-keploy/api-testing-functions.md @@ -13,11 +13,10 @@ Assertions define the **"Pass/Fail"** criteria for your tests. While standard ch - **Custom Functions**: Use these for complex logic that simple matching cannot handle, such as verifying if a timestamp falls within a specific range. - **Global Functions**: Repeatable logic can be saved to the Global library for team-wide reuse. - - ## Hands-On: Schema Assertions ### 1. Selecting Fields to Assert + Choose specifically which parts of a JSON response Keploy should validate during a replay. Schema assertion configuration selecting response fields on a Keploy API test @@ -25,17 +24,20 @@ Choose specifically which parts of a JSON response Keploy should validate during **Example Context:** In this window, we are targeting a `GET` request on the `/visits/-1` endpoint that expects a `400` status code. Under **Response Fields**, specific keys like `className` and `exMessage` are selected. Toggling these ensures Keploy validates that these fields are returned as the correct data type (strings) during every replay. ### 2. Multi-Type Assertions + Stack different assertion types, such as verifying a status code while simultaneously checking if a specific field contains a certain value. Multiple assertion types applied to a single Keploy API test **Example Context:** This setup enforces two rules simultaneously: + 1. **Status Code**: Validates that the server returns a `201` (Created). 2. **JSON Contains**: Specifically checks the `city` header/field to ensure it matches the expected value `"sometown"`. ## Custom & Global Functions ### 1. Writing Inline Logic + Access the `request` and `response` objects directly to create complex rules within the assertion panel. Custom Functions @@ -43,9 +45,9 @@ Access the `request` and `response` objects directly to create complex rules wit **Example Context:** The editor shows a function signature: `function customFunction(request, response)`. This gives you direct access to the full objects, allowing you to write JavaScript logic to determine if the test should pass based on dynamic conditions. ### 2. Global Function Library + Save repeatable validation rules to the Global Custom Functions library so they can be reused across your entire development team. Global Functions - -**Example Context:** The library shows reusable logic stored globally. For example, the `customFunction` at the bottom demonstrates an `assert.greater(response.status, 399)` utility, creating a standardized rule to verify error-level status codes across multiple suites. \ No newline at end of file +**Example Context:** The library shows reusable logic stored globally. For example, the `customFunction` at the bottom demonstrates an `assert.greater(response.status, 399)` utility, creating a standardized rule to verify error-level status codes across multiple suites. diff --git a/versioned_docs/version-4.0.0/running-keploy/api-testing-variables.md b/versioned_docs/version-4.0.0/running-keploy/api-testing-variables.md index 6512e55f5..59643bff7 100644 --- a/versioned_docs/version-4.0.0/running-keploy/api-testing-variables.md +++ b/versioned_docs/version-4.0.0/running-keploy/api-testing-variables.md @@ -15,21 +15,22 @@ Variables in Keploy act as placeholders for dynamic data that changes between te - **Extraction**: This involves identifying specific data points within an API response—such as an ID, a token, or a status string—and mapping them to a unique variable name in the **Variables** tab of the **Edit Test Step** panel. - **Injection**: Once a variable is captured, it can be dynamically inserted into subsequent URLs, Headers, or Request Bodies using the double-curly brace syntax: `{{variable_name}}`. -- **Global vs. Suite Scope**: - - **Suite Variables**: These are ephemeral and captured from previous steps within a specific test suite run to maintain state across a single workflow. - - **Global Variables**: These are persistent constants, such as base URLs, environment-specific keys, or static authentication tokens, available across all suites in the workspace. +- **Global vs. Suite Scope**: + - **Suite Variables**: These are ephemeral and captured from previous steps within a specific test suite run to maintain state across a single workflow. + - **Global Variables**: These are persistent constants, such as base URLs, environment-specific keys, or static authentication tokens, available across all suites in the workspace. ## Hands-On: Implementation ### 1. Extraction from Responses -To reuse data, you define a mapping that tells Keploy exactly where to look in a previous response. -Keploy Architecture +To reuse data, you define a mapping that tells Keploy exactly where to look in a previous response. +Keploy Architecture **Example Context:** In the view above, we are extracting the unique ID of a record. The mapping `steps["Create_Owner"].response.body.id` captures the value from the **Create_Owner** step. Note the **Unused** badge; Keploy provides this visual hint when a variable has been defined but hasn't been injected into any subsequent request yet. ### 2. Injection into Requests + Injection allows you to replace static values with dynamic variables, ensuring your tests remain flexible across different environments and data states. Injecting a dynamic variable into a Keploy API test request @@ -37,8 +38,9 @@ Injection allows you to replace static values with dynamic variables, ensuring y **Example Context:** This view shows the **Request Details** for an API call to the `/owners` endpoint. By defining the method (e.g., **POST**), you can then use placeholders like `{{owner_id}}` in the URL path or body. Keploy will automatically swap the placeholder with the actual value captured during test execution. ### 3. Global Variable Management + Global variables serve as the centralized source of truth for your testing environment. Configuring global variables in Keploy API testing -**Example Context:** The **Global Variables** dashboard allows you to manage workspace-wide data. This includes static entries like the **base URL** and dynamic **Global Custom Functions**. For instance, `generateCompanyId()` is a function that returns a unique string starting with `COMP_` followed by a timestamp, ensuring unique identifiers for every test run. \ No newline at end of file +**Example Context:** The **Global Variables** dashboard allows you to manage workspace-wide data. This includes static entries like the **base URL** and dynamic **Global Custom Functions**. For instance, `generateCompanyId()` is a function that returns a unique string starting with `COMP_` followed by a timestamp, ensuring unique identifiers for every test run. From 0301cd3c59390e04f94e6500e8d3c0d2790de5ae Mon Sep 17 00:00:00 2001 From: dhananjay6561 Date: Fri, 7 Aug 2026 15:33:51 +0530 Subject: [PATCH 05/26] style(docs): prettier (2.8.8) on DocItem Wrap the long articleImage fallback line and flatten the pre-existing nested-ternary indentation so the swizzled DocItem is clean under the CI-pinned prettier 2.8.8 (--check runs on changed files). Signed-off-by: dhananjay6561 --- src/theme/DocItem/index.js | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/src/theme/DocItem/index.js b/src/theme/DocItem/index.js index caa8b00a1..9aa0029d8 100644 --- a/src/theme/DocItem/index.js +++ b/src/theme/DocItem/index.js @@ -127,10 +127,10 @@ export default function DocItem(props) { const schemaType = schemaTypeFromFrontMatter ? schemaTypeFromFrontMatter : isApi - ? "APIReference" - : isBlog - ? "BlogPosting" - : "Article"; + ? "APIReference" + : isBlog + ? "BlogPosting" + : "Article"; const authorList = toPersonList(frontMatter?.author || frontMatter?.authors); const maintainerList = toPersonList(frontMatter?.maintainer); const contributorList = toPersonList(frontMatter?.contributor); @@ -150,7 +150,8 @@ export default function DocItem(props) { // Article schema requires an `image`; fall back to the site-wide default // social card (the same 1200x630 og:image set in docusaurus.config.js) when // a doc has no front-matter image, so every Article carries a valid image. - const articleImage = socialImage || "https://keploy.io/images/keploy-hero.png"; + const articleImage = + socialImage || "https://keploy.io/images/keploy-hero.png"; const normalizedMetaKeywords = Array.isArray(metaKeywords) ? metaKeywords.join(", ") : metaKeywords; From 7f927db48d2c0ac7678c3630713deea38b70fa03 Mon Sep 17 00:00:00 2001 From: dhananjay6561 Date: Fri, 7 Aug 2026 15:49:35 +0530 Subject: [PATCH 06/26] style(docs): format DocItem for CI prettier 3.9.6 The prettify_code workflow pins prettier_version 2.8.8, but creyD/ prettier_action's npx step actually installs and runs prettier 3.9.6. 3.x changed nested-ternary indentation, so the prior 2.8.8-flattened schemaType ternary failed CI. Reformat to 3.9.6 (the version CI runs) so --check passes; all other changed files are already 3.9.6-clean. Signed-off-by: dhananjay6561 --- src/theme/DocItem/index.js | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/theme/DocItem/index.js b/src/theme/DocItem/index.js index 9aa0029d8..af68b4aed 100644 --- a/src/theme/DocItem/index.js +++ b/src/theme/DocItem/index.js @@ -127,10 +127,10 @@ export default function DocItem(props) { const schemaType = schemaTypeFromFrontMatter ? schemaTypeFromFrontMatter : isApi - ? "APIReference" - : isBlog - ? "BlogPosting" - : "Article"; + ? "APIReference" + : isBlog + ? "BlogPosting" + : "Article"; const authorList = toPersonList(frontMatter?.author || frontMatter?.authors); const maintainerList = toPersonList(frontMatter?.maintainer); const contributorList = toPersonList(frontMatter?.contributor); From b4d42f074b69bea3f29c9a5e795300786f7aa457 Mon Sep 17 00:00:00 2001 From: dhananjay6561 Date: Fri, 7 Aug 2026 16:04:06 +0530 Subject: [PATCH 07/26] feat(docs): specialize doc schema to TechArticle/APIReference (Doc2) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Every /docs page emitted a generic Article. Route API-reference pages (api-testing-*, public-api, cli-commands, sdk-installation — by tag or path) to APIReference, and default all other docs to TechArticle. Both are Article subtypes accepting the same properties as articleSchema, so the schema shape is unchanged — just a precise, AI/Google-friendly type. Built HTML: 35 APIReference, 343 TechArticle, 0 generic Article from docs. Signed-off-by: dhananjay6561 --- src/theme/DocItem/index.js | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/src/theme/DocItem/index.js b/src/theme/DocItem/index.js index af68b4aed..a9b7bf824 100644 --- a/src/theme/DocItem/index.js +++ b/src/theme/DocItem/index.js @@ -116,21 +116,31 @@ export default function DocItem(props) { ); const schemaTypeFromFrontMatter = frontMatter?.schemaType || frontMatter?.schema_type; + const docTags = frontMatter?.tags || []; const isApi = frontMatter?.apiReference === true || frontMatter?.type === "api" || - (frontMatter?.tags || []).includes?.("api"); + docTags.includes?.("api") || + docTags.includes?.("api-testing") || + // API-reference doc paths (suites, endpoints, CLI, SDK install). + /\/running-keploy\/(api-testing-|public-api|cli-commands)|\/server\/sdk-installation\//.test( + metadata?.permalink || "" + ); const isBlog = frontMatter?.type === "blog" || frontMatter?.blog === true || - (frontMatter?.tags || []).includes?.("blog"); + docTags.includes?.("blog"); + // Every Keploy doc is a technical article, so default to TechArticle rather + // than the generic Article (both are Article subtypes accepting the same + // properties as articleSchema below — no shape change, just a precise type). + // API-reference pages use the more specific APIReference. const schemaType = schemaTypeFromFrontMatter ? schemaTypeFromFrontMatter : isApi ? "APIReference" : isBlog ? "BlogPosting" - : "Article"; + : "TechArticle"; const authorList = toPersonList(frontMatter?.author || frontMatter?.authors); const maintainerList = toPersonList(frontMatter?.maintainer); const contributorList = toPersonList(frontMatter?.contributor); From 563815c42426ef9d29db63b8767491563f4ac1fd Mon Sep 17 00:00:00 2001 From: dhananjay6561 Date: Fri, 7 Aug 2026 16:06:13 +0530 Subject: [PATCH 08/26] fix(docs): unique meta descriptions for 6 pages (A7) general-glossary + 3 glossary terms shared one boilerplate description; share-tests copied the generate-api-tests description; k8s-proxy had a wrong (NextJS/Drizzle) description. Give each a unique, accurate one to clear SEMrush 'Duplicate meta descriptions'. Signed-off-by: dhananjay6561 --- versioned_docs/version-4.0.0/concepts/general-glossary.md | 2 +- .../version-4.0.0/concepts/reference/glossary/beta-testing.md | 2 +- .../concepts/reference/glossary/end-to-end-testing.md | 2 +- .../version-4.0.0/concepts/reference/glossary/error-guessing.md | 2 +- versioned_docs/version-4.0.0/quickstart/k8s-proxy.md | 2 +- versioned_docs/version-4.0.0/running-keploy/share-tests.md | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/versioned_docs/version-4.0.0/concepts/general-glossary.md b/versioned_docs/version-4.0.0/concepts/general-glossary.md index 1ec910f96..dcd581986 100644 --- a/versioned_docs/version-4.0.0/concepts/general-glossary.md +++ b/versioned_docs/version-4.0.0/concepts/general-glossary.md @@ -2,7 +2,7 @@ id: general-glossary title: General Glossary for Users sidebar_label: Glossary -description: This glossary has an explanation of all the terminologies that beginners find difficult to understand at first glance. +description: Plain-language definitions of common software testing terms — unit, integration, end-to-end, regression, mocks, and stubs — for developers getting started with Keploy. tags: - explanation - reference diff --git a/versioned_docs/version-4.0.0/concepts/reference/glossary/beta-testing.md b/versioned_docs/version-4.0.0/concepts/reference/glossary/beta-testing.md index d4a396941..7dfc1faa8 100644 --- a/versioned_docs/version-4.0.0/concepts/reference/glossary/beta-testing.md +++ b/versioned_docs/version-4.0.0/concepts/reference/glossary/beta-testing.md @@ -2,7 +2,7 @@ id: beta-testing title: Beta Testing sidebar_label: Beta Testing -description: This glossary has an explanation of all the terminologies that beginners find difficult to understand at first glance. +description: What is beta testing? Learn its purpose, common types, and where it fits in the software release cycle before a product ships to all users. tags: - explanation - Glossary diff --git a/versioned_docs/version-4.0.0/concepts/reference/glossary/end-to-end-testing.md b/versioned_docs/version-4.0.0/concepts/reference/glossary/end-to-end-testing.md index 83dd711af..f88061f09 100644 --- a/versioned_docs/version-4.0.0/concepts/reference/glossary/end-to-end-testing.md +++ b/versioned_docs/version-4.0.0/concepts/reference/glossary/end-to-end-testing.md @@ -2,7 +2,7 @@ id: end-to-end-testing title: Creating end to end tests with Keploy sidebar_label: End To End Testing -description: This glossary has an explanation of all the terminologies that beginners find difficult to understand at first glance. +description: What is end-to-end testing, and how to create E2E tests with Keploy by recording and replaying real API traffic across your services. tags: - explanation - Glossary diff --git a/versioned_docs/version-4.0.0/concepts/reference/glossary/error-guessing.md b/versioned_docs/version-4.0.0/concepts/reference/glossary/error-guessing.md index db4a8b2c2..88ead4dac 100644 --- a/versioned_docs/version-4.0.0/concepts/reference/glossary/error-guessing.md +++ b/versioned_docs/version-4.0.0/concepts/reference/glossary/error-guessing.md @@ -2,7 +2,7 @@ id: error-guessing title: Error Guessing sidebar_label: Error Guessing -description: This glossary has an explanation of all the terminologies that beginners find difficult to understand at first glance. +description: What is error guessing in software testing? An experience-based technique for uncovering defects that formal test cases miss, with practical examples. tags: - explanation - glossary diff --git a/versioned_docs/version-4.0.0/quickstart/k8s-proxy.md b/versioned_docs/version-4.0.0/quickstart/k8s-proxy.md index e2f35e469..73d0189fe 100644 --- a/versioned_docs/version-4.0.0/quickstart/k8s-proxy.md +++ b/versioned_docs/version-4.0.0/quickstart/k8s-proxy.md @@ -1,7 +1,7 @@ --- id: k8s-proxy title: K8s Record Replay -description: The following sample app to test Keploy integration capabilities using NextJS,Drizzle and Postgres. +description: Record and replay API tests inside a Kubernetes cluster using the Keploy proxy — capture live traffic and rerun it as tests with no code changes. tags: - K8s - Microservices diff --git a/versioned_docs/version-4.0.0/running-keploy/share-tests.md b/versioned_docs/version-4.0.0/running-keploy/share-tests.md index 5a62e2f6a..7c295c527 100644 --- a/versioned_docs/version-4.0.0/running-keploy/share-tests.md +++ b/versioned_docs/version-4.0.0/running-keploy/share-tests.md @@ -2,7 +2,7 @@ id: share-tests title: Share Test Suite With Your Team sidebar_label: Share Test Suite -description: Learn how to use Keploy’s API Test Generator to generate high-quality API test suites using AI from OpenAPI, curl, Postman, or traffic. +description: Learn how to share Keploy API test suites and run reports with teammates via links, so collaborators can review results without any local setup. --- import ProductTier from '@site/src/components/ProductTier'; From 98e2a80d8f6eec3528d9877e2e7d440633acb741 Mon Sep 17 00:00:00 2001 From: dhananjay6561 Date: Fri, 7 Aug 2026 16:06:53 +0530 Subject: [PATCH 09/26] style(docs): prettier 3.9.6 on beta-testing.md Pre-existing leading-space paragraphs (unrelated to the description change) would fail the prettier CI check once the file is touched. Signed-off-by: dhananjay6561 --- .../concepts/reference/glossary/beta-testing.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/versioned_docs/version-4.0.0/concepts/reference/glossary/beta-testing.md b/versioned_docs/version-4.0.0/concepts/reference/glossary/beta-testing.md index 7dfc1faa8..ce1ff618a 100644 --- a/versioned_docs/version-4.0.0/concepts/reference/glossary/beta-testing.md +++ b/versioned_docs/version-4.0.0/concepts/reference/glossary/beta-testing.md @@ -53,35 +53,35 @@ There are many benefits to beta testing, including: Bugs and flaws can be found and fixed early in the development process, which saves time and money. **Example: Dropbox** - During the beta phase for a major feature update, Dropbox discovered that certain file sync issues only occurred under specific conditions, which the internal testing had not captured. This early detection allowed them to resolve these issues, saving time and resources that would have been spent addressing them post-launch. +During the beta phase for a major feature update, Dropbox discovered that certain file sync issues only occurred under specific conditions, which the internal testing had not captured. This early detection allowed them to resolve these issues, saving time and resources that would have been spent addressing them post-launch. ### **Improved user experience:** Beta testers can provide feedback on how to improve the user experience. **Example: Google Chrome** - Google regularly uses beta testing to refine the user interface and functionality of Chrome. During a beta release of a new tab layout, users provided feedback about the accessibility of certain features. Based on this feedback, Google adjusted the layout to enhance usability, ensuring that the final version was more user-friendly. +Google regularly uses beta testing to refine the user interface and functionality of Chrome. During a beta release of a new tab layout, users provided feedback about the accessibility of certain features. Based on this feedback, Google adjusted the layout to enhance usability, ensuring that the final version was more user-friendly. ### **Gathering feedback:** Beta testers can provide feedback on the product's features, functionality, and performance. **Example: Instagram** - When Instagram introduced a new Stories feature, they conducted beta testing with a selected group of users. Feedback regarding the feature's visibility and ease of use led to several adjustments, such as changing the placement of the Stories bar. This feedback was critical in ensuring the feature's success upon full release. +When Instagram introduced a new Stories feature, they conducted beta testing with a selected group of users. Feedback regarding the feature's visibility and ease of use led to several adjustments, such as changing the placement of the Stories bar. This feedback was critical in ensuring the feature's success upon full release. ### **Promoting user acceptance:** Beta testing can help to promote user acceptance of the product by getting the word out about it. **Example: Tesla** - Tesla often invites existing customers to participate in beta testing for new software updates. By allowing loyal customers to be part of the testing process, Tesla promotes user acceptance and loyalty, as these users feel invested in the development of new features. +Tesla often invites existing customers to participate in beta testing for new software updates. By allowing loyal customers to be part of the testing process, Tesla promotes user acceptance and loyalty, as these users feel invested in the development of new features. ### **Boosting software quality:** Beta testing can help to boost the quality of the software by ensuring that it is as stable, safe, and functional as possible. **Example: Spotify** - Spotify uses beta testing to explore new features like collaborative playlists. By inviting a small group of users to test this feature and providing a structured feedback mechanism, Spotify was able to gauge interest and refine the feature before rolling it out to the entire user base. +Spotify uses beta testing to explore new features like collaborative playlists. By inviting a small group of users to test this feature and providing a structured feedback mechanism, Spotify was able to gauge interest and refine the feature before rolling it out to the entire user base. ## How to Beta Test From ae5086840083921e3b72f92537b634ee03ad20a2 Mon Sep 17 00:00:00 2001 From: dhananjay6561 Date: Fri, 7 Aug 2026 16:29:22 +0530 Subject: [PATCH 10/26] feat(docs): add structured data to bespoke pages (Doc2) /leadership, /security and /privacy-policy emitted zero page-level schema. Add JSON-LD: leadership -> CollectionPage + ItemList of Person (name, photo, Twitter, worksFor Keploy); security -> WebPage + security ContactPoint (responsible-disclosure email); privacy-policy -> DigitalDocument with dateModified. Verified in built HTML. Signed-off-by: dhananjay6561 --- src/pages/leadership.js | 41 +++++++++++++++++++++++++++++++++++++ src/pages/privacy-policy.js | 21 +++++++++++++++++++ src/pages/security.js | 27 ++++++++++++++++++++++++ 3 files changed, 89 insertions(+) diff --git a/src/pages/leadership.js b/src/pages/leadership.js index 07fb122a9..e3d000b01 100644 --- a/src/pages/leadership.js +++ b/src/pages/leadership.js @@ -2,6 +2,7 @@ import React from "react"; import clsx from "clsx"; import Layout from "@theme/Layout"; import Link from "@docusaurus/Link"; +import Head from "@docusaurus/Head"; import useDocusaurusContext from "@docusaurus/useDocusaurusContext"; import useBaseUrl from "@docusaurus/useBaseUrl"; import styles from "./styles.module.css"; @@ -9,8 +10,48 @@ import styles from "./styles.module.css"; export default function Security() { const context = useDocusaurusContext(); const {siteConfig = {}} = context; + const team = [ + { + name: "Neha Gupta", + image: "https://avatars.githubusercontent.com/u/15074229?v=4", + sameAs: "https://twitter.com/know_neha", + }, + { + name: "Shubham Jain", + image: "https://avatars.githubusercontent.com/u/12831254?v=4", + sameAs: "https://twitter.com/slayerjain", + }, + ]; + // CollectionPage of Person entities so search engines / AI can resolve the + // Keploy leadership team (name, photo, social profile) as structured people. + const leadershipSchema = { + "@context": "https://schema.org", + "@type": "CollectionPage", + name: "Keploy Leadership", + url: `${siteConfig.url}/docs/Leadership`, + isPartOf: {"@type": "WebSite", url: siteConfig.url}, + mainEntity: { + "@type": "ItemList", + itemListElement: team.map((person, i) => ({ + "@type": "ListItem", + position: i + 1, + item: { + "@type": "Person", + name: person.name, + image: person.image, + worksFor: {"@type": "Organization", name: "Keploy"}, + sameAs: [person.sameAs], + }, + })), + }, + }; return ( + + +
  • diff --git a/src/pages/privacy-policy.js b/src/pages/privacy-policy.js index ca0001a35..06bfa010f 100644 --- a/src/pages/privacy-policy.js +++ b/src/pages/privacy-policy.js @@ -1,16 +1,37 @@ import React from "react"; import Layout from "@theme/Layout"; +import Head from "@docusaurus/Head"; import useDocusaurusContext from "@docusaurus/useDocusaurusContext"; function PrivacyPolicy() { const context = useDocusaurusContext(); const {siteConfig = {}} = context; + // DigitalDocument with a real dateModified so the legal doc's freshness is + // machine-readable rather than emitting nothing. + const privacySchema = { + "@context": "https://schema.org", + "@type": "DigitalDocument", + name: "Keploy, Inc. Privacy Policy", + url: `${siteConfig.url}/docs/privacy-policy`, + dateModified: "2024-04-28", + isPartOf: {"@type": "WebSite", url: siteConfig.url}, + publisher: { + "@type": "Organization", + name: "Keploy", + url: "https://keploy.io", + }, + }; return ( + + +
    Keploy Inc. Privacy Policy diff --git a/src/pages/security.js b/src/pages/security.js index c1ccb251c..07f1a5bf4 100644 --- a/src/pages/security.js +++ b/src/pages/security.js @@ -2,6 +2,7 @@ import React from "react"; import clsx from "clsx"; import Layout from "@theme/Layout"; import Link from "@docusaurus/Link"; +import Head from "@docusaurus/Head"; import useDocusaurusContext from "@docusaurus/useDocusaurusContext"; import useBaseUrl from "@docusaurus/useBaseUrl"; import styles from "./styles.module.css"; @@ -9,12 +10,38 @@ import styles from "./styles.module.css"; export default function Security() { const context = useDocusaurusContext(); const {siteConfig = {}} = context; + // WebPage + security ContactPoint so the responsible-disclosure channel is + // machine-readable (this page is linked from every doc footer). + const securitySchema = { + "@context": "https://schema.org", + "@type": "WebPage", + name: "Keploy Security Practices and Policies", + url: `${siteConfig.url}/docs/security`, + description: + "Learn how Keploy ensures data protection, privacy, and secure testing — Keploy's security measures, policies, and responsible-disclosure process.", + isPartOf: {"@type": "WebSite", url: siteConfig.url}, + publisher: { + "@type": "Organization", + name: "Keploy", + url: "https://keploy.io", + contactPoint: { + "@type": "ContactPoint", + contactType: "security", + email: "hello@keploy.io", + }, + }, + }; return ( + + +

    From 46a9ac3936a9265dad97d4db2665b512f85061bf Mon Sep 17 00:00:00 2001 From: dhananjay6561 Date: Fri, 7 Aug 2026 16:53:18 +0530 Subject: [PATCH 11/26] feat(docs): emit FAQPage schema for FAQ docs (Doc2/AI4) New dependency-free remark plugin extracts each ### question + following answer prose from FAQ docs (keploy-explained/*-faq) and injects FAQPage JSON-LD with Question/acceptedAnswer pairs, so they're eligible for FAQ rich results and AI extraction. Built HTML: FAQPage with 14/11/12 Q&A on the three FAQ pages. Signed-off-by: dhananjay6561 --- docusaurus.config.js | 4 ++ src/remark/remarkFaqSchema.js | 116 ++++++++++++++++++++++++++++++++++ 2 files changed, 120 insertions(+) create mode 100644 src/remark/remarkFaqSchema.js diff --git a/docusaurus.config.js b/docusaurus.config.js index ec3984ad1..a33aac8d1 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -2,6 +2,7 @@ import {themes as prismThemes} from "prism-react-renderer"; const path = require("path"); +const remarkFaqSchema = require("./src/remark/remarkFaqSchema"); const fs = require("fs"); import {visit} from "unist-util-visit"; const FontPreloadPlugin = require("webpack-font-preload-plugin"); @@ -484,6 +485,9 @@ fbq('track', 'PageView');`, }, {}, ], + // Emit FAQPage JSON-LD (Question/Answer) for FAQ docs so they are + // eligible for FAQ rich results and AI extraction. + remarkFaqSchema, ], }, // Will be passed to @docusaurus/plugin-content-blog diff --git a/src/remark/remarkFaqSchema.js b/src/remark/remarkFaqSchema.js new file mode 100644 index 000000000..5604b819c --- /dev/null +++ b/src/remark/remarkFaqSchema.js @@ -0,0 +1,116 @@ +// remarkFaqSchema — emit FAQPage JSON-LD for FAQ docs. +// +// FAQ pages (keploy-explained/*-faq.md) are written as a list of +// `### ` headings each followed by answer prose. Google/AI can only +// extract them as an FAQ rich result if the page carries FAQPage structured +// data with Question/Answer pairs — which Docusaurus does not generate. +// +// This build-time plugin detects FAQ docs (by file path), pulls each level-2/3 +// heading as a Question and the prose that follows (until the next heading) as +// the acceptedAnswer, and injects a )} - {articleSchema && ( + {collectionPageSchema && ( )} diff --git a/src/pages/leadership.js b/src/pages/leadership.js index e3d000b01..7b7ce0f59 100644 --- a/src/pages/leadership.js +++ b/src/pages/leadership.js @@ -6,6 +6,7 @@ import Head from "@docusaurus/Head"; import useDocusaurusContext from "@docusaurus/useDocusaurusContext"; import useBaseUrl from "@docusaurus/useBaseUrl"; import styles from "./styles.module.css"; +import {DOCS_URL, organizationRef, websiteRef} from "../schema/siteEntities"; export default function Security() { const context = useDocusaurusContext(); @@ -28,8 +29,9 @@ export default function Security() { "@context": "https://schema.org", "@type": "CollectionPage", name: "Keploy Leadership", - url: `${siteConfig.url}/docs/Leadership`, - isPartOf: {"@type": "WebSite", url: siteConfig.url}, + url: `${DOCS_URL}Leadership/`, + isPartOf: websiteRef, + publisher: organizationRef, mainEntity: { "@type": "ItemList", itemListElement: team.map((person, i) => ({ @@ -39,7 +41,7 @@ export default function Security() { "@type": "Person", name: person.name, image: person.image, - worksFor: {"@type": "Organization", name: "Keploy"}, + worksFor: organizationRef, sameAs: [person.sameAs], }, })), diff --git a/src/pages/privacy-policy.js b/src/pages/privacy-policy.js index 06bfa010f..e7f764a82 100644 --- a/src/pages/privacy-policy.js +++ b/src/pages/privacy-policy.js @@ -2,6 +2,7 @@ import React from "react"; import Layout from "@theme/Layout"; import Head from "@docusaurus/Head"; import useDocusaurusContext from "@docusaurus/useDocusaurusContext"; +import {DOCS_URL, organizationRef, websiteRef} from "../schema/siteEntities"; function PrivacyPolicy() { const context = useDocusaurusContext(); @@ -12,14 +13,10 @@ function PrivacyPolicy() { "@context": "https://schema.org", "@type": "DigitalDocument", name: "Keploy, Inc. Privacy Policy", - url: `${siteConfig.url}/docs/privacy-policy`, + url: `${DOCS_URL}privacy-policy/`, dateModified: "2024-04-28", - isPartOf: {"@type": "WebSite", url: siteConfig.url}, - publisher: { - "@type": "Organization", - name: "Keploy", - url: "https://keploy.io", - }, + isPartOf: websiteRef, + publisher: organizationRef, }; return ( of every +// route via the site-wide `headTags` graph, so these always resolve. +const organizationRef = {"@id": ORGANIZATION_ID}; +const websiteRef = {"@id": WEBSITE_ID}; + +// `trailingSlash: true` means the slash-less form of any internal path 301s +// to the canonical one. Hand-written paths (glossary data, hard-coded hrefs) +// routinely omit it, which costs a redirect hop for users and makes JSON-LD +// URLs disagree with the canonical tag. +function withTrailingSlash(path) { + if (!path || path.endsWith("/")) { + return path; + } + return `${path}/`; +} + +const organizationNode = { + "@type": "Organization", + "@id": ORGANIZATION_ID, + name: "Keploy", + url: `${SITE_URL}/`, + logo: { + "@type": "ImageObject", + "@id": `${SITE_URL}/#logo`, + url: `${SITE_URL}/images/keploy-logo-full.svg`, + caption: "Keploy", + }, + foundingDate: "2021-01-01", + knowsAbout: [ + "API Testing", + "Test Automation", + "eBPF-based Testing", + "Dependency Virtualization", + "AI-Powered Testing", + ], + award: [ + "API World 2023 Award: Best in API Infrastructure", + "CNCF Landscape", + "Google for Startups Accelerator", + "Google Summer of Code Mentoring Organization", + ], + sameAs: [ + "https://github.com/keploy", + "https://twitter.com/Keployio", + "https://www.linkedin.com/company/keploy", + "https://www.youtube.com/@keploy", + "https://discord.gg/keploy", + "https://community.keploy.io", + "https://marketplace.visualstudio.com/items?itemName=Keploy.keployio", + "https://chromewebstore.google.com/detail/keploy-api-test-recorder/ohcclfkaidblnjnggclkiecgkpgldihe", + "https://www.crunchbase.com/organization/hybridk8s", + "https://www.gartner.com/reviews/product/keploy-618993540", + "https://www.g2.com/products/keploy/reviews", + "https://www.capterra.in/software/1070466/Keploy", + "https://aws.amazon.com/marketplace/reviews/reviews-list/prodview-xgwmdk4ivjjv4", + ], +}; + +const websiteNode = { + "@type": "WebSite", + "@id": WEBSITE_ID, + name: "Keploy Documentation", + url: DOCS_URL, + publisher: organizationRef, + potentialAction: { + "@type": "SearchAction", + target: `${DOCS_URL}search?q={search_term_string}`, + "query-input": "required name=search_term_string", + }, +}; + +const softwareApplicationNode = { + "@type": "SoftwareApplication", + "@id": SOFTWARE_APPLICATION_ID, + name: "Keploy", + description: + "Keploy is an open-source, AI-powered testing agent and sandboxing platform that automatically generates test cases, dependency mocks, and production-like sandboxes from real user traffic using eBPF. It helps developers achieve 90% test coverage in minutes with zero code changes. Native support is available on Linux; macOS and Windows require a Linux environment such as Lima, WSL, or Docker.", + applicationCategory: "DeveloperTool", + applicationSubCategory: "Test Automation", + operatingSystem: "Linux", + license: "https://www.apache.org/licenses/LICENSE-2.0", + softwareHelp: DOCS_URL, + codeRepository: "https://github.com/keploy/keploy", + downloadUrl: "https://github.com/keploy/keploy/releases", + isAccessibleForFree: true, + url: SITE_URL, + featureList: [ + "Automatic test case generation from real user traffic", + "Production-like sandbox environments from captured traffic", + "AI-powered dependency virtualization and mock generation", + "Record and replay testing with eBPF kernel capture", + "AI noise detection for flaky test elimination", + "Legacy application testing without code changes", + "Migration regression testing against production baselines", + "Continuous validation in CI/CD pipelines", + "Multi-language support (Go, Java, TypeScript, Python)", + ], + keywords: [ + "test automation", + "API testing", + "API test generation", + "unit testing", + "integration testing", + "mock generation", + "dependency virtualization", + "eBPF-based testing", + "record and replay", + "production sandbox", + ], + programmingLanguage: ["Go", "Java", "TypeScript", "JavaScript", "Python"], + publisher: organizationRef, +}; + +// One graph for the whole site, injected into every route via `headTags`. +// Replaces three sibling )} + {definedTermSchema && ( + + )} {Array.isArray(frontMatter.head) && frontMatter.head.map((headTag, i) => { if (!headTag?.tag) return null; From 429537c500d7d37ad08c0368846ded549865ab38 Mon Sep 17 00:00:00 2001 From: dhananjay6561 Date: Mon, 10 Aug 2026 11:19:19 +0530 Subject: [PATCH 13/26] fix(docs): resolve residual SEO audit items (A8, A9) - samples-echo: two body sections used a single `#`, producing three h1s on the page (title + two). Demote both to `##` so the page has one h1 and a clean heading hierarchy (A8, multiple-h1). - configuration-file: rewrite four in-body doc links from http:// to https:// (the two remaining http:// occurrences are regex examples in a code block and are left as-is) (A9, HTTP-link-on-HTTPS-site). - api-testing-auth-setup: the title "Auth Setup" was flagged as too short and its description was a near-duplicate stub; give it a descriptive title and a unique description (sidebar_label stays "Auth Setup") (A9, title-too-short). Verified: clean build (onBrokenLinks: throw), verify-schema-graph 0 invalid / 0 dangling. Signed-off-by: dhananjay6561 --- versioned_docs/version-4.0.0/quickstart/samples-echo.md | 4 ++-- .../running-keploy/api-testing-auth-setup.md | 4 ++-- .../version-4.0.0/running-keploy/configuration-file.md | 8 ++++---- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/versioned_docs/version-4.0.0/quickstart/samples-echo.md b/versioned_docs/version-4.0.0/quickstart/samples-echo.md index 40076e4cf..0ea3e2b9e 100644 --- a/versioned_docs/version-4.0.0/quickstart/samples-echo.md +++ b/versioned_docs/version-4.0.0/quickstart/samples-echo.md @@ -55,7 +55,7 @@ text: "Run keploy test -c \"CMD_TO_RUN_APP\" --delay 10 to replay the recorded t import InstallReminder from '@site/src/components/InstallReminder'; import SectionDivider from '@site/src/components/SectionDivider'; -# Using Docker Compose 🐳 +## Using Docker Compose 🐳 import ProductTier from '@site/src/components/ProductTier'; @@ -150,7 +150,7 @@ Happy coding! ✨👩‍💻👨‍💻✨ --- -# Running App Locally on Linux/WSL 🐧 +## Running App Locally on Linux/WSL 🐧 diff --git a/versioned_docs/version-4.0.0/running-keploy/api-testing-auth-setup.md b/versioned_docs/version-4.0.0/running-keploy/api-testing-auth-setup.md index 866e2db57..7b229d653 100644 --- a/versioned_docs/version-4.0.0/running-keploy/api-testing-auth-setup.md +++ b/versioned_docs/version-4.0.0/running-keploy/api-testing-auth-setup.md @@ -1,8 +1,8 @@ --- id: api-testing-auth-setup -title: Auth Setup +title: Authentication Setup for API Testing sidebar_label: Auth Setup -description: Auth setup for API Testing +description: Configure authentication for Keploy API testing — set up bearer tokens, API keys, and custom auth headers so recorded suites replay against protected endpoints. tags: - API testing - webhooks diff --git a/versioned_docs/version-4.0.0/running-keploy/configuration-file.md b/versioned_docs/version-4.0.0/running-keploy/configuration-file.md index 2e209b702..ab20dfcc6 100644 --- a/versioned_docs/version-4.0.0/running-keploy/configuration-file.md +++ b/versioned_docs/version-4.0.0/running-keploy/configuration-file.md @@ -85,7 +85,7 @@ keployNetwork: "keploy-network" ## Using the Config File -The Keploy-config file eliminates the need to repeatedly specify parameters for each record or test command. The parameters in the file correspond to the flags in the Keploy [CLI Command Docs](http://keploy.io/docs/running-keploy/cli-commands/).Using keploy-config can help to reduce the record and test command to just: +The Keploy-config file eliminates the need to repeatedly specify parameters for each record or test command. The parameters in the file correspond to the flags in the Keploy [CLI Command Docs](https://keploy.io/docs/running-keploy/cli-commands/).Using keploy-config can help to reduce the record and test command to just: ### Record Command: @@ -99,7 +99,7 @@ keploy record keploy test ``` -Visit the [CLI Command Docs](http://keploy.io/docs/running-keploy/cli-commands/) to know more about the flags/parameters and their usage. +Visit the [CLI Command Docs](https://keploy.io/docs/running-keploy/cli-commands/) to know more about the flags/parameters and their usage. ## Configuration Sections @@ -380,7 +380,7 @@ In the provided example: ## Advanced Noise Filtering: -Earlier the only way to add the [noisy fields](http://keploy.io/docs/concepts/general-glossary/#3-noisy-field) was by modifying individual test file (testcase level). Now, With the introduction of config file, users can add the noisy fields at test-set and global level through config file itself. +Earlier the only way to add the [noisy fields](https://keploy.io/docs/concepts/general-glossary/#3-noisy-field) was by modifying individual test file (testcase level). Now, With the introduction of config file, users can add the noisy fields at test-set and global level through config file itself. ### Global Noise @@ -485,6 +485,6 @@ The `globalNoise` and `test-sets` are optional fields in the config file. If not Congratulations! You've now explored the features and configuration options provided by `Keploy-config`. -Now armed with Keploy-config, you are ready to embark on a more organized and productive journey of recording and testing APIs with Keploy. Feel free to explore additional features, customize configurations, and refer to the [CLI Command Docs](http://keploy.io/docs/running-keploy/cli-commands/) for more details on available flags and parameters. +Now armed with Keploy-config, you are ready to embark on a more organized and productive journey of recording and testing APIs with Keploy. Feel free to explore additional features, customize configurations, and refer to the [CLI Command Docs](https://keploy.io/docs/running-keploy/cli-commands/) for more details on available flags and parameters. Happy testing and may your APIs always return the expected results! 🚀 From 4ffad6085955aa78451457a340bb3707df835696 Mon Sep 17 00:00:00 2001 From: dhananjay6561 Date: Mon, 10 Aug 2026 11:47:16 +0530 Subject: [PATCH 14/26] docs(A5): expand thin SCM PR-agent page with capabilities + related links integrations-pr-agent was ~120 words (flagged "low word count"). Add a "What the PR Agent does" section and a Related block linking the AI test generator, UTG PR agent, and CI/CD GitHub setup, so the page carries real content and more than one internal link (A4). Signed-off-by: dhananjay6561 --- .../keploy-explained/integrations-pr-agent.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/versioned_docs/version-4.0.0/keploy-explained/integrations-pr-agent.md b/versioned_docs/version-4.0.0/keploy-explained/integrations-pr-agent.md index eba900f91..d063c2ab9 100644 --- a/versioned_docs/version-4.0.0/keploy-explained/integrations-pr-agent.md +++ b/versioned_docs/version-4.0.0/keploy-explained/integrations-pr-agent.md @@ -13,10 +13,20 @@ tags: Keploy’s PR Agent helps automate code reviews, testing, and feedback—right where you work. +## What the PR Agent does + +The PR Agent runs Keploy inside your source-control workflow and comments back on the pull request itself, so test feedback lives next to the code being reviewed instead of in a separate dashboard. On each pull request it can: + +- **Generate and run tests** against the changed code and report pass/fail status as a PR check. +- **Surface coverage** so reviewers can see whether new code is exercised by tests before merging. +- **Leave inline feedback** on the diff, highlighting untested paths or regressions the recorded suites catch. + +This keeps the "did this change break anything?" question answerable at review time, rather than after a merge. + ## ✅ Currently Supported **GitHub:** - Our PR Agent seamlessly integrates with GitHub repositories for test automation, coverage checks, and intelligent feedback on your pull requests. +Our PR Agent seamlessly integrates with GitHub repositories for test automation, coverage checks, and intelligent feedback on your pull requests. If you already run Keploy in CI, the PR Agent complements the [CI/CD GitHub setup](/docs/ci-cd/github/) by adding review-time feedback on top of your pipeline runs. ## 💡 Need Support for Another Platform? @@ -27,3 +37,9 @@ Want Keploy’s PR Agent on GitLab, Bitbucket, or another platform? We’re always open to feedback and requests as we expand our integration support. **More integrations are coming soon—stay tuned!** + +## Related + +- [Generate API tests using AI](/docs/running-keploy/generate-api-tests-using-ai/) — the test-generation engine the PR Agent runs on your changes. +- [UTG PR Agent (unit-test generation on PRs)](/docs/running-keploy/utg-pr-agent/) — the companion agent for unit tests. +- [CI/CD with GitHub Actions](/docs/ci-cd/github/) — wire Keploy into your GitHub pipeline. From f7ae0b9df7432f6466773f0defb974a8e87f3854 Mon Sep 17 00:00:00 2001 From: dhananjay6561 Date: Mon, 10 Aug 2026 11:47:16 +0530 Subject: [PATCH 15/26] docs(A5): expand Windows/WSL install page with prerequisites + related links windows-wsl was ~177 words. Add why-WSL context, a Prerequisites section, clearer install steps, and a Related block (macOS/Linux install, CLI reference, common errors) to fix the thin-content and single-internal-link flags (A5/A4). Signed-off-by: dhananjay6561 --- .../keploy-explained/windows-wsl.md | 34 +++++++++++++++---- 1 file changed, 28 insertions(+), 6 deletions(-) diff --git a/versioned_docs/version-4.0.0/keploy-explained/windows-wsl.md b/versioned_docs/version-4.0.0/keploy-explained/windows-wsl.md index a9c9123a0..f1f309d07 100644 --- a/versioned_docs/version-4.0.0/keploy-explained/windows-wsl.md +++ b/versioned_docs/version-4.0.0/keploy-explained/windows-wsl.md @@ -15,19 +15,33 @@ keywords: - installation --- -On Windows, WSL is required to run Keploy Binary. You must be running Windows 10 version 2004 and higher (Build 19041 -and higher) or Windows 11 to use the commands below. +Keploy relies on the Linux kernel's eBPF subsystem to capture network traffic, so it does not run directly on the Windows kernel. On Windows you run Keploy inside **WSL (Windows Subsystem for Linux)**, which gives you a real Linux kernel while keeping your Windows development environment. This page covers the WSL prerequisites and installs the Keploy binary inside that Linux environment. + +## Prerequisites + +- **Windows 10** version 2004 or higher (Build 19041 and higher), or **Windows 11**. +- Administrator access to run `wsl --install` the first time. +- A working internet connection to pull the WSL distribution and the Keploy release. + +## Enable WSL and install a Linux distribution + +Open PowerShell or Windows Terminal **as Administrator** and run: ```shell wsl --install -d ``` -Recommended to use "Ubuntu-22.04" +We recommend **"Ubuntu-22.04"**: -This command will enable the features necessary to run WSL and install the Ubuntu distribution of Linux. (This default -distribution can be changed). +```shell +wsl --install -d Ubuntu-22.04 +``` -Install "Keploy Binary" : +This command enables the features necessary to run WSL and installs the chosen Ubuntu distribution of Linux. (The default distribution can be changed.) You may be prompted to restart Windows and to create a Linux username and password on first launch. + +## Install the Keploy binary + +Once you are inside your WSL Ubuntu shell, install the Keploy binary: ```shell curl --silent --location "https://github.com/keploy/keploy/releases/latest/download/keploy_linux_amd64.tar.gz" | tar xz -C /tmp @@ -35,6 +49,8 @@ curl --silent --location "https://github.com/keploy/keploy/releases/latest/downl sudo mkdir -p /usr/local/bin && sudo mv /tmp/keploy /usr/local/bin && keploy ``` +Running `keploy` should print the CLI help, confirming the binary is on your `PATH`. From here on, run every Keploy command from inside the WSL shell (not native PowerShell), and keep your application code on the WSL filesystem for the best performance. + Congratulations! You've successfully set up Keploy natively on Windows. ## What's Next? @@ -44,3 +60,9 @@ Congratulations! You've successfully set up Keploy natively on Windows. Begin recording your API calls and generating test cases with Keploy. #### [Back to Installation Guide](/docs/server/installation/) + +## Related + +- [Running Keploy on macOS and Linux](/docs/keploy-explained/mac-linux/) — the equivalent setup for other operating systems. +- [CLI commands reference](/docs/running-keploy/cli-commands/) — every `keploy` command and flag. +- [Common errors and fixes](/docs/keploy-explained/common-errors/) — troubleshooting, including WSL-specific issues. From 8f505e66dc2726bafb7b45b6b3d34d9a38ebc62e Mon Sep 17 00:00:00 2001 From: dhananjay6561 Date: Mon, 10 Aug 2026 11:47:23 +0530 Subject: [PATCH 16/26] docs(A4): add "Related Terms" cross-links to all 37 glossary pages MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Glossary term pages each had only one internal link (SEMrush "pages with only one internal link"). Add a "Related Terms" section to every term page linking 3–4 conceptually related terms plus the glossary hub, so terms form a connected cluster that both readers and AI engines can traverse. Link targets use each term's real route slug (e.g. agile-testing.md serves at /agile-unit-testing/, grey-box-testing.md at /gray-box-testing/), verified by a clean build under onBrokenLinks: throw. Signed-off-by: dhananjay6561 --- .../reference/glossary/acceptance-testing.md | 8 ++++++++ .../concepts/reference/glossary/agile-testing.md | 8 ++++++++ .../reference/glossary/ai-test-completion.md | 8 ++++++++ .../glossary/behaviour-driven-development.md | 8 ++++++++ .../concepts/reference/glossary/beta-testing.md | 8 ++++++++ .../reference/glossary/black-box-testing.md | 8 ++++++++ .../concepts/reference/glossary/code-coverage.md | 7 +++++++ .../reference/glossary/component-testing.md | 8 ++++++++ .../reference/glossary/cucumber-testing.md | 8 ++++++++ .../reference/glossary/data-driven-testing.md | 8 ++++++++ .../reference/glossary/defect-management.md | 8 ++++++++ .../reference/glossary/end-to-end-testing.md | 8 ++++++++ .../reference/glossary/error-guessing.md | 7 +++++++ .../reference/glossary/functional-testing.md | 8 ++++++++ .../reference/glossary/grey-box-testing.md | 8 ++++++++ .../concepts/reference/glossary/grpc.md | 8 ++++++++ .../concepts/reference/glossary/idempotency.md | 16 ++++++++++++---- .../reference/glossary/integration-testing.md | 8 ++++++++ .../concepts/reference/glossary/junit.md | 8 ++++++++ .../concepts/reference/glossary/load-testing.md | 7 +++++++ .../reference/glossary/manual-testing.md | 7 +++++++ .../reference/glossary/microservice-testing.md | 7 +++++++ .../concepts/reference/glossary/mocks.md | 7 +++++++ .../reference/glossary/negative-testing.md | 7 +++++++ .../reference/glossary/observability-testing.md | 7 +++++++ .../reference/glossary/performance-testing.md | 7 +++++++ .../concepts/reference/glossary/qa-automation.md | 8 ++++++++ .../reference/glossary/regression-testing.md | 7 +++++++ .../reference/glossary/reliability-testing.md | 7 +++++++ .../glossary/software-testing-life-cycle.md | 7 +++++++ .../concepts/reference/glossary/stubs.md | 7 +++++++ .../reference/glossary/test-data-generation.md | 7 +++++++ .../glossary/test-driven-development.md | 8 ++++++++ .../reference/glossary/unit-test-automation.md | 8 ++++++++ .../concepts/reference/glossary/unit-testing.md | 8 ++++++++ .../glossary/visual-regression-testing.md | 7 +++++++ .../reference/glossary/white-box-testing.md | 8 ++++++++ 37 files changed, 285 insertions(+), 4 deletions(-) diff --git a/versioned_docs/version-4.0.0/concepts/reference/glossary/acceptance-testing.md b/versioned_docs/version-4.0.0/concepts/reference/glossary/acceptance-testing.md index b50f12bbc..a7ba09b62 100644 --- a/versioned_docs/version-4.0.0/concepts/reference/glossary/acceptance-testing.md +++ b/versioned_docs/version-4.0.0/concepts/reference/glossary/acceptance-testing.md @@ -69,6 +69,14 @@ To ensure the effectiveness of acceptance testing, consider the following best p Acceptance testing is a critical step in the software development process, ensuring that the product is ready for deployment and meets the user's needs. By following best practices and involving key stakeholders, organizations can deliver high-quality software that satisfies customer expectations. +## Related Terms + +- [End-to-End Testing](/docs/concepts/reference/glossary/end-to-end-testing/) — validates complete user flows before release. +- [Integration Testing](/docs/concepts/reference/glossary/integration-testing/) — precedes acceptance testing in the cycle. +- [Behaviour Driven Development](/docs/concepts/reference/glossary/behaviour-driven-development/) — defines acceptance criteria in plain language. +- [Software Testing Life Cycle](/docs/concepts/reference/glossary/software-testing-life-cycle/) — where acceptance testing fits overall. +- [Browse all testing terms](/docs/concepts/reference/glossary/) — the full Keploy glossary. + ## FAQs ### What is the difference between UAT and Systematic Testing? diff --git a/versioned_docs/version-4.0.0/concepts/reference/glossary/agile-testing.md b/versioned_docs/version-4.0.0/concepts/reference/glossary/agile-testing.md index ffabafa86..6705de562 100644 --- a/versioned_docs/version-4.0.0/concepts/reference/glossary/agile-testing.md +++ b/versioned_docs/version-4.0.0/concepts/reference/glossary/agile-testing.md @@ -35,3 +35,11 @@ Agile unit testing is typically done by developers. Developers write unit tests ### Conclusion Agile unit testing is a valuable tool for improving the quality of software applications. By following the best practices for agile unit testing, developers can help to ensure that their applications are free of defects and meet the needs of their users. + +## Related Terms + +- [Unit Testing](/docs/concepts/reference/glossary/unit-testing/) — the core practice agile teams apply frequently. +- [Test Driven Development](/docs/concepts/reference/glossary/test-driven-development/) — a key principle of agile unit testing. +- [Behaviour Driven Development](/docs/concepts/reference/glossary/behaviour-driven-development/) — another Agile, collaboration-focused method. +- [Unit Test Automation](/docs/concepts/reference/glossary/unit-test-automation/) — agile tests run automatically in CI. +- [Browse all testing terms](/docs/concepts/reference/glossary/) — the full Keploy glossary. diff --git a/versioned_docs/version-4.0.0/concepts/reference/glossary/ai-test-completion.md b/versioned_docs/version-4.0.0/concepts/reference/glossary/ai-test-completion.md index f40807969..da13ea51d 100644 --- a/versioned_docs/version-4.0.0/concepts/reference/glossary/ai-test-completion.md +++ b/versioned_docs/version-4.0.0/concepts/reference/glossary/ai-test-completion.md @@ -59,6 +59,14 @@ By using Keploy’s AI-based testing : AI Test Completion represents a significant advancement in software testing, leveraging AI and ML to automate and improve the testing process. By automating test case generation, predicting potential scenarios, and enhancing test coverage, AI Test Completion enables teams to achieve higher efficiency, accuracy, and scalability in their testing efforts. However, challenges such as data quality, setup complexity, and integration issues must be addressed to fully leverage the benefits of AI-driven testing. Integrating AI Test Completion into testing workflows can empower teams to deliver robust software solutions that meet user expectations and business requirements effectively. +## Related Terms + +- [Unit Test Automation](/docs/concepts/reference/glossary/unit-test-automation/) — AI accelerates automated unit test creation. +- [Test Data Generation](/docs/concepts/reference/glossary/test-data-generation/) — AI produces inputs and edge cases. +- [Code Coverage](/docs/concepts/reference/glossary/code-coverage/) — AI-generated tests aim to raise coverage. +- [QA Automation](/docs/concepts/reference/glossary/qa-automation/) — AI extends broader test automation efforts. +- [Browse all testing terms](/docs/concepts/reference/glossary/) — the full Keploy glossary. + ## FAQ ### How does AI test completion work? diff --git a/versioned_docs/version-4.0.0/concepts/reference/glossary/behaviour-driven-development.md b/versioned_docs/version-4.0.0/concepts/reference/glossary/behaviour-driven-development.md index aeae9d09b..5166d4416 100644 --- a/versioned_docs/version-4.0.0/concepts/reference/glossary/behaviour-driven-development.md +++ b/versioned_docs/version-4.0.0/concepts/reference/glossary/behaviour-driven-development.md @@ -174,6 +174,14 @@ Popular BDD tools include: Behavior Driven Development (BDD) is a collaborative Agile methodology that improves communication among developers, testers, and business stakeholders. By focusing on user stories and scenarios written in plain language, BDD ensures that software meets real user needs and business objectives. With the support of BDD tools like Cucumber, Behave, and SpecFlow, teams can automate tests, integrate them into CI/CD pipelines, and maintain living documentation of system behavior. Although BDD requires commitment and may involve a learning curve, its benefits in improving collaboration, testability, and software quality make it a valuable addition to modern development practices. +## Related Terms + +- [Test Driven Development](/docs/concepts/reference/glossary/test-driven-development/) — BDD evolves from the TDD approach. +- [Cucumber Testing](/docs/concepts/reference/glossary/cucumber-testing/) — popular tool for automating BDD scenarios. +- [Acceptance Testing](/docs/concepts/reference/glossary/acceptance-testing/) — BDD scenarios double as acceptance criteria. +- [Agile Unit Testing](/docs/concepts/reference/glossary/agile-unit-testing/) — BDD is an Agile collaboration methodology. +- [Browse all testing terms](/docs/concepts/reference/glossary/) — the full Keploy glossary. + ## FAQs about Behavior Driven Development (BDD) ### 1. What is Behavior Driven Development (BDD)? diff --git a/versioned_docs/version-4.0.0/concepts/reference/glossary/beta-testing.md b/versioned_docs/version-4.0.0/concepts/reference/glossary/beta-testing.md index ce1ff618a..eb57b917d 100644 --- a/versioned_docs/version-4.0.0/concepts/reference/glossary/beta-testing.md +++ b/versioned_docs/version-4.0.0/concepts/reference/glossary/beta-testing.md @@ -97,3 +97,11 @@ Here are some tips for beta testing: ## Conclusion Beta testing is an important part of the software development process. By beta testing a product, developers can get valuable feedback from real users and improve the quality of the product before it is released to the general public. + +## Related Terms + +- [Acceptance Testing](/docs/concepts/reference/glossary/acceptance-testing/) — validates user needs just before release. +- [End-to-End Testing](/docs/concepts/reference/glossary/end-to-end-testing/) — checks full flows ahead of beta. +- [Manual Testing](/docs/concepts/reference/glossary/manual-testing/) — beta relies on real users testing manually. +- [Software Testing Life Cycle](/docs/concepts/reference/glossary/software-testing-life-cycle/) — where beta testing fits before launch. +- [Browse all testing terms](/docs/concepts/reference/glossary/) — the full Keploy glossary. diff --git a/versioned_docs/version-4.0.0/concepts/reference/glossary/black-box-testing.md b/versioned_docs/version-4.0.0/concepts/reference/glossary/black-box-testing.md index cf0c8c73d..7fac50be7 100644 --- a/versioned_docs/version-4.0.0/concepts/reference/glossary/black-box-testing.md +++ b/versioned_docs/version-4.0.0/concepts/reference/glossary/black-box-testing.md @@ -149,6 +149,14 @@ testing with Keploy: Black-box testing is a valuable tool for ensuring the quality of software. It can be used to find a wide range of defects, and it can be performed by testers with a variety of skill levels. The best testing strategy for a particular software project will depend on the specific needs of the project. In some cases, black-box testing may be sufficient. In other cases, white-box testing may be necessary to find all the defects in the software. +## Related Terms + +- [White Box Testing](/docs/concepts/reference/glossary/white-box-testing/) — the opposite, code-aware testing approach. +- [Grey Box Testing](/docs/concepts/reference/glossary/gray-box-testing/) — combines black-box and white-box techniques. +- [Functional Testing](/docs/concepts/reference/glossary/functional-testing/) — verifies behavior without internal knowledge. +- [Regression Testing](/docs/concepts/reference/glossary/regression-testing/) — often done via black-box test cases. +- [Browse all testing terms](/docs/concepts/reference/glossary/) — the full Keploy glossary. + ## FAQ ### What is black-box testing? diff --git a/versioned_docs/version-4.0.0/concepts/reference/glossary/code-coverage.md b/versioned_docs/version-4.0.0/concepts/reference/glossary/code-coverage.md index 9b2b2a6f0..57adde730 100644 --- a/versioned_docs/version-4.0.0/concepts/reference/glossary/code-coverage.md +++ b/versioned_docs/version-4.0.0/concepts/reference/glossary/code-coverage.md @@ -90,3 +90,10 @@ Now when let's the test cases with Jest, you can see the code coverage report ge ```bash npm test ``` + +## Related Terms + +- [Unit Testing](/docs/concepts/reference/glossary/unit-testing/) — the tests whose reach coverage measures. +- [Unit Test Automation](/docs/concepts/reference/glossary/unit-test-automation/) — automating those tests to raise coverage. +- [Test-Driven Development](/docs/concepts/reference/glossary/test-driven-development/) — writing tests first tends to lift coverage. +- [Browse all testing terms](/docs/concepts/reference/glossary/) — the full Keploy glossary. diff --git a/versioned_docs/version-4.0.0/concepts/reference/glossary/component-testing.md b/versioned_docs/version-4.0.0/concepts/reference/glossary/component-testing.md index abd44e5c9..1baa583ef 100644 --- a/versioned_docs/version-4.0.0/concepts/reference/glossary/component-testing.md +++ b/versioned_docs/version-4.0.0/concepts/reference/glossary/component-testing.md @@ -239,6 +239,14 @@ Component testing is pretty much testing on a single unit of your software. By t Using the Keploy tool makes it easier to do component testing. Keploy will create tests and mocks that derive from the ways real users use your app automatically, allowing you to spend less time writing tests and more time building features without worry. In summary, good component testing and effective tools such as Keploy can help you deliver better software, faster. +## Related Terms + +- [Unit Testing](/docs/concepts/reference/glossary/unit-testing/) — tests the smallest isolated pieces of code. +- [Integration Testing](/docs/concepts/reference/glossary/integration-testing/) — follows component testing to check interactions. +- [Stubs](/docs/concepts/reference/glossary/stubs/) — simulate dependencies during component tests. +- [Mocks](/docs/concepts/reference/glossary/mocks/) — stand in for external services in isolation. +- [Browse all testing terms](/docs/concepts/reference/glossary/) — the full Keploy glossary. + ## FAQs ### 1. Is component testing the same as unit testing? diff --git a/versioned_docs/version-4.0.0/concepts/reference/glossary/cucumber-testing.md b/versioned_docs/version-4.0.0/concepts/reference/glossary/cucumber-testing.md index 715fead28..1ccf72904 100644 --- a/versioned_docs/version-4.0.0/concepts/reference/glossary/cucumber-testing.md +++ b/versioned_docs/version-4.0.0/concepts/reference/glossary/cucumber-testing.md @@ -104,6 +104,14 @@ While Cucumber is widely used for BDD and Gherkin-based testing, several alterna Cucumber testing revolutionizes software testing by enabling teams to collaborate effectively through executable specifications written in Gherkin. By bridging communication gaps between stakeholders and automating tests with reusable step definitions, Cucumber enhances the reliability, maintainability, and scalability of software applications. Incorporating Cucumber into BDD practices empowers teams to deliver high-quality software that meets business requirements and user expectations seamlessly. +## Related Terms + +- [Behaviour Driven Development](/docs/concepts/reference/glossary/behaviour-driven-development/) — the methodology Cucumber implements. +- [Acceptance Testing](/docs/concepts/reference/glossary/acceptance-testing/) — Cucumber writes human-readable acceptance tests. +- [Data Driven Testing](/docs/concepts/reference/glossary/data-driven-testing/) — Cucumber supports it via examples tables. +- [Test Driven Development](/docs/concepts/reference/glossary/test-driven-development/) — a related test-first development practice. +- [Browse all testing terms](/docs/concepts/reference/glossary/) — the full Keploy glossary. + ## FAQ about Cucumber Testing ### 1. **What is Cucumber testing used for?** diff --git a/versioned_docs/version-4.0.0/concepts/reference/glossary/data-driven-testing.md b/versioned_docs/version-4.0.0/concepts/reference/glossary/data-driven-testing.md index 3ab3b4e1f..4293bf6fa 100644 --- a/versioned_docs/version-4.0.0/concepts/reference/glossary/data-driven-testing.md +++ b/versioned_docs/version-4.0.0/concepts/reference/glossary/data-driven-testing.md @@ -81,6 +81,14 @@ Begin with a simple pilot project to demonstrate value. Choose a critical user w Focus on high-value scenarios where multiple data combinations are essential. Login functionality, payment processing, and form validations are excellent starting points. +## Related Terms + +- [Test Data Generation](/docs/concepts/reference/glossary/test-data-generation/) — supplies the data sets these tests consume. +- [QA Automation](/docs/concepts/reference/glossary/qa-automation/) — data-driven tests are typically automated. +- [Regression Testing](/docs/concepts/reference/glossary/regression-testing/) — reruns many data sets to catch regressions. +- [Cucumber Testing](/docs/concepts/reference/glossary/cucumber-testing/) — supports data-driven scenarios via examples tables. +- [Browse all testing terms](/docs/concepts/reference/glossary/) — the full Keploy glossary. + ## Frequently Asked Questions ### Q: How much effort does it take to implement data-driven testing? diff --git a/versioned_docs/version-4.0.0/concepts/reference/glossary/defect-management.md b/versioned_docs/version-4.0.0/concepts/reference/glossary/defect-management.md index 11d969f0d..69b0f3b58 100644 --- a/versioned_docs/version-4.0.0/concepts/reference/glossary/defect-management.md +++ b/versioned_docs/version-4.0.0/concepts/reference/glossary/defect-management.md @@ -254,6 +254,14 @@ With proper practices and tools, shipping **high-quality, reliable applications* Let's continue to pursue excellence in software quality! +## Related Terms + +- [Software Testing Life Cycle](/docs/concepts/reference/glossary/software-testing-life-cycle/) — defect management spans the whole cycle. +- [Regression Testing](/docs/concepts/reference/glossary/regression-testing/) — verifies fixed defects stay fixed. +- [Error Guessing](/docs/concepts/reference/glossary/error-guessing/) — a technique for uncovering defects. +- [Acceptance Testing](/docs/concepts/reference/glossary/acceptance-testing/) — catches defects before release. +- [Browse all testing terms](/docs/concepts/reference/glossary/) — the full Keploy glossary. + ## FAQs ### What is a defect in software testing? diff --git a/versioned_docs/version-4.0.0/concepts/reference/glossary/end-to-end-testing.md b/versioned_docs/version-4.0.0/concepts/reference/glossary/end-to-end-testing.md index f88061f09..6de6986f0 100644 --- a/versioned_docs/version-4.0.0/concepts/reference/glossary/end-to-end-testing.md +++ b/versioned_docs/version-4.0.0/concepts/reference/glossary/end-to-end-testing.md @@ -65,6 +65,14 @@ Since you don't require to setup any test environment, Keploy can be used in any End-to-end (E2E) testing is a important component of the software development process, as it ensures that applications function correctly and meet user expectations across all integrated components. While E2E testing presents challenges, such as time consumption and automation complexity, tools like Keploy offer powerful solutions to streamline the process. By capturing and replaying real-world API interactions, Keploy enhances the efficiency and effectiveness of end-to-end testing, contributing to the delivery of high-quality software. +## Related Terms + +- [Integration Testing](/docs/concepts/reference/glossary/integration-testing/) — checks module interactions before E2E. +- [Acceptance Testing](/docs/concepts/reference/glossary/acceptance-testing/) — validates the finished product for users. +- [Mocks](/docs/concepts/reference/glossary/mocks/) — Keploy uses mocks to replay E2E dependencies. +- [Regression Testing](/docs/concepts/reference/glossary/regression-testing/) — reruns E2E flows to catch regressions. +- [Browse all testing terms](/docs/concepts/reference/glossary/) — the full Keploy glossary. + ## FAQs ### What is End-to-End Testing? diff --git a/versioned_docs/version-4.0.0/concepts/reference/glossary/error-guessing.md b/versioned_docs/version-4.0.0/concepts/reference/glossary/error-guessing.md index 88ead4dac..b01341e0d 100644 --- a/versioned_docs/version-4.0.0/concepts/reference/glossary/error-guessing.md +++ b/versioned_docs/version-4.0.0/concepts/reference/glossary/error-guessing.md @@ -38,3 +38,10 @@ Error guessing is an intuitive and experience-based software testing technique t ## Conclusion While error guessing is not systematic like other testing methods, it can be highly effective when combined with more structured approaches. It allows testers to explore edge cases and unusual scenarios that might be overlooked by conventional test cases. However, the success of error guessing largely depends on the tester's expertise and familiarity with the system. As such, it's often used as a complementary technique rather than a standalone method in comprehensive testing strategies. + +## Related Terms + +- [Negative Testing](/docs/concepts/reference/glossary/negative-testing/) — deliberately probing invalid inputs, a close cousin. +- [Black-Box Testing](/docs/concepts/reference/glossary/black-box-testing/) — experience-based testing without seeing the code. +- [Manual Testing](/docs/concepts/reference/glossary/manual-testing/) — where error guessing is most often applied. +- [Browse all testing terms](/docs/concepts/reference/glossary/) — the full Keploy glossary. diff --git a/versioned_docs/version-4.0.0/concepts/reference/glossary/functional-testing.md b/versioned_docs/version-4.0.0/concepts/reference/glossary/functional-testing.md index e27c52591..a3c5d1ac7 100644 --- a/versioned_docs/version-4.0.0/concepts/reference/glossary/functional-testing.md +++ b/versioned_docs/version-4.0.0/concepts/reference/glossary/functional-testing.md @@ -211,6 +211,14 @@ Integrate functional tests into your Continuous Integration (CI) pipelines. This Despite the challenges, functional testing is an important part of the software testing process. By following good functional testing practices, you can help to ensure that the software system meets the specified requirements and meets the intended business needs. +## Related Terms + +- [Black Box Testing](/docs/concepts/reference/glossary/black-box-testing/) — functional testing is largely black-box. +- [Integration Testing](/docs/concepts/reference/glossary/integration-testing/) — a functional testing type for module interactions. +- [Regression Testing](/docs/concepts/reference/glossary/regression-testing/) — re-verifies functionality after changes. +- [Unit Testing](/docs/concepts/reference/glossary/unit-testing/) — the most granular functional test level. +- [Browse all testing terms](/docs/concepts/reference/glossary/) — the full Keploy glossary. + ## Frequently Asked Questions ### 1. What is Functional Testing? diff --git a/versioned_docs/version-4.0.0/concepts/reference/glossary/grey-box-testing.md b/versioned_docs/version-4.0.0/concepts/reference/glossary/grey-box-testing.md index 0851df202..3fb9b5f50 100644 --- a/versioned_docs/version-4.0.0/concepts/reference/glossary/grey-box-testing.md +++ b/versioned_docs/version-4.0.0/concepts/reference/glossary/grey-box-testing.md @@ -97,6 +97,14 @@ Some commonly used tools for gray box testing include: Gray box testing is a versatile and effective software testing approach that blends the principles of black box and white box testing. It enables testers to design test cases based on both functional specifications and partial internal knowledge of the application, leading to improved test coverage and defect identification. By leveraging techniques such as matrix testing, regression testing, pattern testing, and more, gray box testing strikes a balance between thoroughness and practicality. This approach is particularly beneficial in identifying security vulnerabilities, ensuring robust error handling, and enhancing overall software quality. Despite its challenges, including the need for intermediate skill levels and potentially higher complexity, the benefits of gray box testing make it a valuable component of a comprehensive testing strategy. +## Related Terms + +- [Black Box Testing](/docs/concepts/reference/glossary/black-box-testing/) — tests with no internal knowledge. +- [White Box Testing](/docs/concepts/reference/glossary/white-box-testing/) — tests with full code knowledge. +- [Functional Testing](/docs/concepts/reference/glossary/functional-testing/) — gray box blends functional and structural views. +- [Integration Testing](/docs/concepts/reference/glossary/integration-testing/) — gray box suits integrating complex systems. +- [Browse all testing terms](/docs/concepts/reference/glossary/) — the full Keploy glossary. + ## FAQ's ### What is gray box testing? diff --git a/versioned_docs/version-4.0.0/concepts/reference/glossary/grpc.md b/versioned_docs/version-4.0.0/concepts/reference/glossary/grpc.md index 8f246258f..9eb524007 100644 --- a/versioned_docs/version-4.0.0/concepts/reference/glossary/grpc.md +++ b/versioned_docs/version-4.0.0/concepts/reference/glossary/grpc.md @@ -130,6 +130,14 @@ Performance optimizations continue to improve efficiency, with new compression a The growing ecosystem of tools and libraries makes gRPC increasingly accessible to developers. IDE integrations, debugging tools, and testing frameworks reduce the learning curve and improve developer productivity. +## Related Terms + +- [Microservice Testing](/docs/concepts/reference/glossary/microservice-testing/) — gRPC powers microservice communication. +- [Integration Testing](/docs/concepts/reference/glossary/integration-testing/) — validates gRPC service interactions. +- [Mocks](/docs/concepts/reference/glossary/mocks/) — stand in for gRPC dependencies in tests. +- [Idempotency](/docs/concepts/reference/glossary/idempotency/) — key to reliable RPC retries in distributed systems. +- [Browse all testing terms](/docs/concepts/reference/glossary/) — the full Keploy glossary. + ## Frequently Asked Questions ### What's the main difference between gRPC and REST? diff --git a/versioned_docs/version-4.0.0/concepts/reference/glossary/idempotency.md b/versioned_docs/version-4.0.0/concepts/reference/glossary/idempotency.md index 941942358..84b60f031 100644 --- a/versioned_docs/version-4.0.0/concepts/reference/glossary/idempotency.md +++ b/versioned_docs/version-4.0.0/concepts/reference/glossary/idempotency.md @@ -78,16 +78,16 @@ While **idempotent** methods guarantee the same outcome when repeated, **safe** ### How Keploy Ensures Idempotency - **Automated Test Cases for Idempotent Operations:** - Keploy lets you create tests that simulate repeated API requests under various conditions—such as network failures, timeouts, or duplicate submissions—to confirm that operations like **PUT**, **DELETE**, and **GET** remain consistent. + Keploy lets you create tests that simulate repeated API requests under various conditions—such as network failures, timeouts, or duplicate submissions—to confirm that operations like **PUT**, **DELETE**, and **GET** remain consistent. - **Simulating Failures and Retrying Requests:** - By simulating transient network issues or service unavailability, Keploy verifies that retry logic does not cause multiple, unintended modifications to the system. + By simulating transient network issues or service unavailability, Keploy verifies that retry logic does not cause multiple, unintended modifications to the system. - **Request and Response Pairing:** - Keploy tracks request-response pairs to ensure that each repeated request produces an identical outcome, validating the correct handling of idempotent tokens (like UUIDs). + Keploy tracks request-response pairs to ensure that each repeated request produces an identical outcome, validating the correct handling of idempotent tokens (like UUIDs). - **Advanced Mocking and Stubbing:** - With Keploy’s capabilities, you can simulate external service interactions, allowing you to test the idempotency of your APIs in isolation and under specific failure conditions. + With Keploy’s capabilities, you can simulate external service interactions, allowing you to test the idempotency of your APIs in isolation and under specific failure conditions. ### Example Use Case @@ -101,6 +101,14 @@ Imagine an API that updates a user's profile using the **PUT** method. Automated Idempotency is a foundational principle in designing reliable, scalable RESTful APIs. By ensuring that operations can be retried safely without adverse effects, idempotent APIs contribute to system consistency, error recovery, and overall performance. Implementing idempotent methods involves careful design of HTTP methods, data handling, and error recovery mechanisms. Tools like Keploy simplify this process by providing robust testing frameworks that simulate real-world conditions, ensuring that your APIs maintain their idempotency under all circumstances. +## Related Terms + +- [Reliability Testing](/docs/concepts/reference/glossary/reliability-testing/) — idempotency underpins fault-tolerant systems. +- [Microservice Testing](/docs/concepts/reference/glossary/microservice-testing/) — idempotency matters across service retries. +- [Integration Testing](/docs/concepts/reference/glossary/integration-testing/) — verifies idempotent behavior end to end. +- [Mocks](/docs/concepts/reference/glossary/mocks/) — simulate failures to test safe retries. +- [Browse all testing terms](/docs/concepts/reference/glossary/) — the full Keploy glossary. + ## FAQ ### What does it mean for an HTTP method to be idempotent? diff --git a/versioned_docs/version-4.0.0/concepts/reference/glossary/integration-testing.md b/versioned_docs/version-4.0.0/concepts/reference/glossary/integration-testing.md index 3ab2b675f..dc429244f 100644 --- a/versioned_docs/version-4.0.0/concepts/reference/glossary/integration-testing.md +++ b/versioned_docs/version-4.0.0/concepts/reference/glossary/integration-testing.md @@ -121,6 +121,14 @@ Furthermore, Keploy's native integration seamlessly integrates with development In conclusion, Keploy empowers development teams to overcome the challenges of integration testing effectively, enabling them to deliver high-quality software with confidence and efficiency. +## Related Terms + +- [Unit Testing](/docs/concepts/reference/glossary/unit-testing/) — precedes integration testing in the pyramid. +- [End-to-End Testing](/docs/concepts/reference/glossary/end-to-end-testing/) — follows integration testing across the full system. +- [Component Testing](/docs/concepts/reference/glossary/component-testing/) — tests parts before they are integrated. +- [Stubs](/docs/concepts/reference/glossary/stubs/) — simulate not-yet-ready modules during integration. +- [Browse all testing terms](/docs/concepts/reference/glossary/) — the full Keploy glossary. + ### FAQs #### 1. What is the primary goal of integration testing? diff --git a/versioned_docs/version-4.0.0/concepts/reference/glossary/junit.md b/versioned_docs/version-4.0.0/concepts/reference/glossary/junit.md index 4b0a2cf5a..96b0feb17 100644 --- a/versioned_docs/version-4.0.0/concepts/reference/glossary/junit.md +++ b/versioned_docs/version-4.0.0/concepts/reference/glossary/junit.md @@ -116,6 +116,14 @@ Finding the right balance of test coverage requires experience and judgment. Foc Tests that are difficult to maintain eventually become liabilities rather than assets. Regular refactoring of test code, just like production code, ensures tests remain valuable throughout the application lifecycle. +## Related Terms + +- [Unit Testing](/docs/concepts/reference/glossary/unit-testing/) — JUnit is the standard Java unit-testing framework. +- [Test Driven Development](/docs/concepts/reference/glossary/test-driven-development/) — JUnit enables fast red-green-refactor cycles. +- [Code Coverage](/docs/concepts/reference/glossary/code-coverage/) — pair JUnit with JaCoCo to measure coverage. +- [Unit Test Automation](/docs/concepts/reference/glossary/unit-test-automation/) — JUnit runs automatically in CI pipelines. +- [Browse all testing terms](/docs/concepts/reference/glossary/) — the full Keploy glossary. + ## Frequently Asked Questions ### Q: What's the difference between JUnit 4 and JUnit 5? diff --git a/versioned_docs/version-4.0.0/concepts/reference/glossary/load-testing.md b/versioned_docs/version-4.0.0/concepts/reference/glossary/load-testing.md index 8266292cc..40eee416b 100644 --- a/versioned_docs/version-4.0.0/concepts/reference/glossary/load-testing.md +++ b/versioned_docs/version-4.0.0/concepts/reference/glossary/load-testing.md @@ -151,6 +151,13 @@ Load testing is important in the SDLC, since it ensures applications can handle As the load testing market continues to expand, organizations that invest in robust load testing practices will be better positioned to deliver exceptional user experiences and maintain a competitive edge. +## Related Terms + +- [Performance Testing](/docs/concepts/reference/glossary/performance-testing/) — load testing is a core type of performance testing. +- [Reliability Testing](/docs/concepts/reference/glossary/reliability-testing/) — validates stability under sustained load. +- [Observability Testing](/docs/concepts/reference/glossary/observability-testing/) — monitor system behavior during load tests. +- [Browse all testing terms](/docs/concepts/reference/glossary/) — the full Keploy glossary. + ## FAQs ### What is load testing in software development? diff --git a/versioned_docs/version-4.0.0/concepts/reference/glossary/manual-testing.md b/versioned_docs/version-4.0.0/concepts/reference/glossary/manual-testing.md index 8cd9ba536..10f8bd5f0 100644 --- a/versioned_docs/version-4.0.0/concepts/reference/glossary/manual-testing.md +++ b/versioned_docs/version-4.0.0/concepts/reference/glossary/manual-testing.md @@ -57,3 +57,10 @@ Automating manual testing with Keploy can provide several benefits. Such as: - Improved Quality: By catching issues early and ensuring that changes do not break existing functionality, automation testing can help improve the overall quality of the software. Overall, by automating testing processes with Keploy, you can improve testing efficiency, increase test coverage, and accelerate the delivery of high-quality software products while reducing manual effort and costs. + +## Related Terms + +- [QA Automation](/docs/concepts/reference/glossary/qa-automation/) — automate repetitive manual test execution. +- [Regression Testing](/docs/concepts/reference/glossary/regression-testing/) — re-run manual test cases after code changes. +- [Unit Testing](/docs/concepts/reference/glossary/unit-testing/) — a foundational automated alternative to manual checks. +- [Browse all testing terms](/docs/concepts/reference/glossary/) — the full Keploy glossary. diff --git a/versioned_docs/version-4.0.0/concepts/reference/glossary/microservice-testing.md b/versioned_docs/version-4.0.0/concepts/reference/glossary/microservice-testing.md index d59573888..21e0bff0c 100644 --- a/versioned_docs/version-4.0.0/concepts/reference/glossary/microservice-testing.md +++ b/versioned_docs/version-4.0.0/concepts/reference/glossary/microservice-testing.md @@ -52,3 +52,10 @@ Keploy is an innovative testing tool designed to address many of the challenges - **Performance Testing**: The recorded interactions can be used to simulate realistic load scenarios, aiding in performance testing of microservices. By leveraging Keploy's capabilities, development teams can overcome many of the traditional challenges associated with microservices testing, leading to more robust and reliable distributed systems. + +## Related Terms + +- [Integration Testing](/docs/concepts/reference/glossary/integration-testing/) — verify how services interact together. +- [End-to-End Testing](/docs/concepts/reference/glossary/end-to-end-testing/) — validate complete flows across microservices. +- [Mocks](/docs/concepts/reference/glossary/mocks/) — simulate service dependencies during isolated tests. +- [Browse all testing terms](/docs/concepts/reference/glossary/) — the full Keploy glossary. diff --git a/versioned_docs/version-4.0.0/concepts/reference/glossary/mocks.md b/versioned_docs/version-4.0.0/concepts/reference/glossary/mocks.md index f9c7dd5d3..b2c808666 100644 --- a/versioned_docs/version-4.0.0/concepts/reference/glossary/mocks.md +++ b/versioned_docs/version-4.0.0/concepts/reference/glossary/mocks.md @@ -39,3 +39,10 @@ Keploy can generate dependency mocks in addition to the testcases by recording y Keploy recording API calls and replaying them using generated mocks Since these data mocks are generated based on the real-time capturing of API calls from your application, they will be from real-world scenarios. This can help to ensure that the data mocks are accurate and that it represents the real data as closely as possible. As well as, it makes the data maintenance process easier by providing a same environment for testing. This can help to identify the source of bugs more easily. + +## Related Terms + +- [Stubs](/docs/concepts/reference/glossary/stubs/) — a simpler stand-in for dependencies, often confused with mocks. +- [Unit Testing](/docs/concepts/reference/glossary/unit-testing/) — mocks isolate the unit under test. +- [Integration Testing](/docs/concepts/reference/glossary/integration-testing/) — mock external systems between components. +- [Browse all testing terms](/docs/concepts/reference/glossary/) — the full Keploy glossary. diff --git a/versioned_docs/version-4.0.0/concepts/reference/glossary/negative-testing.md b/versioned_docs/version-4.0.0/concepts/reference/glossary/negative-testing.md index d8653499d..a4115c351 100644 --- a/versioned_docs/version-4.0.0/concepts/reference/glossary/negative-testing.md +++ b/versioned_docs/version-4.0.0/concepts/reference/glossary/negative-testing.md @@ -107,6 +107,13 @@ The evolution of testing tools like Keploy demonstrates the growing sophisticati Success in negative testing requires a combination of systematic methodology, appropriate tooling, and continuous adaptation to emerging challenges. Organizations that invest in comprehensive negative testing approaches will be better positioned to deliver reliable, secure, and user-friendly software systems that can withstand the challenges of real-world deployment. +## Related Terms + +- [Error Guessing](/docs/concepts/reference/glossary/error-guessing/) — experience-based way to find failure inputs. +- [Functional Testing](/docs/concepts/reference/glossary/functional-testing/) — the positive counterpart to negative testing. +- [Black Box Testing](/docs/concepts/reference/glossary/black-box-testing/) — test invalid inputs without internal knowledge. +- [Browse all testing terms](/docs/concepts/reference/glossary/) — the full Keploy glossary. + ## Frequently Asked Questions ### 1. What is the primary difference between positive and negative testing? diff --git a/versioned_docs/version-4.0.0/concepts/reference/glossary/observability-testing.md b/versioned_docs/version-4.0.0/concepts/reference/glossary/observability-testing.md index 9d00f02b8..f5c77b3d1 100644 --- a/versioned_docs/version-4.0.0/concepts/reference/glossary/observability-testing.md +++ b/versioned_docs/version-4.0.0/concepts/reference/glossary/observability-testing.md @@ -116,6 +116,13 @@ Observability testing continues to evolve as systems become more complex and mon **Security Observability**: Security monitoring becomes increasingly important as systems face evolving threats. Observability testing must validate that security monitoring capabilities provide comprehensive threat detection and response capabilities. +## Related Terms + +- [Reliability Testing](/docs/concepts/reference/glossary/reliability-testing/) — observability underpins reliability assessment. +- [Microservice Testing](/docs/concepts/reference/glossary/microservice-testing/) — traces span distributed microservices. +- [Performance Testing](/docs/concepts/reference/glossary/performance-testing/) — metrics reveal performance under load. +- [Browse all testing terms](/docs/concepts/reference/glossary/) — the full Keploy glossary. + ## Frequently Asked Questions ### Q: What's the difference between traditional monitoring and observability testing? diff --git a/versioned_docs/version-4.0.0/concepts/reference/glossary/performance-testing.md b/versioned_docs/version-4.0.0/concepts/reference/glossary/performance-testing.md index 566eac1b6..1f0854792 100644 --- a/versioned_docs/version-4.0.0/concepts/reference/glossary/performance-testing.md +++ b/versioned_docs/version-4.0.0/concepts/reference/glossary/performance-testing.md @@ -106,3 +106,10 @@ Using Keploy for performance testing offers several benefits: - **Early Detection**: Identifies performance issues early in the development cycle, reducing the risk of critical problems in production. By leveraging Keploy, teams can streamline their performance testing process, enhance test accuracy, and ensure that their software delivers optimal performance in real-world conditions. + +## Related Terms + +- [Load Testing](/docs/concepts/reference/glossary/load-testing/) — a key type of performance testing under expected load. +- [Reliability Testing](/docs/concepts/reference/glossary/reliability-testing/) — extends performance checks to long-term stability. +- [Observability Testing](/docs/concepts/reference/glossary/observability-testing/) — capture metrics during performance runs. +- [Browse all testing terms](/docs/concepts/reference/glossary/) — the full Keploy glossary. diff --git a/versioned_docs/version-4.0.0/concepts/reference/glossary/qa-automation.md b/versioned_docs/version-4.0.0/concepts/reference/glossary/qa-automation.md index 679d2d974..201187ea3 100644 --- a/versioned_docs/version-4.0.0/concepts/reference/glossary/qa-automation.md +++ b/versioned_docs/version-4.0.0/concepts/reference/glossary/qa-automation.md @@ -150,6 +150,14 @@ The future of QA automation looks promising with advancements in **AI and machin QA automation is essential for modern software development. It enables **faster releases, higher quality, and better collaboration between teams.** By understanding the key components, types of testing, and best practices, organizations can effectively implement QA automation and reap its many benefits. As the field continues to evolve, staying updated with the latest tools and trends will be crucial for maintaining a competitive edge in software quality assurance. +## Related Terms + +- [Regression Testing](/docs/concepts/reference/glossary/regression-testing/) — a prime candidate for automation. +- [Unit Test Automation](/docs/concepts/reference/glossary/unit-test-automation/) — automate tests at the unit level. +- [Manual Testing](/docs/concepts/reference/glossary/manual-testing/) — the approach QA automation replaces or complements. +- [Performance Testing](/docs/concepts/reference/glossary/performance-testing/) — automate load and speed checks. +- [Browse all testing terms](/docs/concepts/reference/glossary/) — the full Keploy glossary. + ## FAQs ### What is QA Automation? diff --git a/versioned_docs/version-4.0.0/concepts/reference/glossary/regression-testing.md b/versioned_docs/version-4.0.0/concepts/reference/glossary/regression-testing.md index da79717ea..8c5e4d15b 100644 --- a/versioned_docs/version-4.0.0/concepts/reference/glossary/regression-testing.md +++ b/versioned_docs/version-4.0.0/concepts/reference/glossary/regression-testing.md @@ -74,6 +74,13 @@ On the other hand, automated regression testing provides consistent, repeatable, Ultimately, the decision should consider the specific needs of the project, balancing the benefits of human judgment in manual testing with the efficiency and scalability offered by automation. Many teams opt for a hybrid approach, combining both methods to maximize test coverage and effectiveness throughout the software development lifecycle. +## Related Terms + +- [QA Automation](/docs/concepts/reference/glossary/qa-automation/) — automate regression suites for faster releases. +- [Unit Testing](/docs/concepts/reference/glossary/unit-testing/) — unit tests catch regressions early. +- [Visual Regression Testing](/docs/concepts/reference/glossary/visual-regression-testing/) — detect unintended UI changes. +- [Browse all testing terms](/docs/concepts/reference/glossary/) — the full Keploy glossary. + ## Frequently Asked Questions ### What is regression testing and why is it important? diff --git a/versioned_docs/version-4.0.0/concepts/reference/glossary/reliability-testing.md b/versioned_docs/version-4.0.0/concepts/reference/glossary/reliability-testing.md index 27b6d37a8..1ba15ff02 100644 --- a/versioned_docs/version-4.0.0/concepts/reference/glossary/reliability-testing.md +++ b/versioned_docs/version-4.0.0/concepts/reference/glossary/reliability-testing.md @@ -117,6 +117,13 @@ Organizations that invest in robust reliability testing practices will be better --- +## Related Terms + +- [Load Testing](/docs/concepts/reference/glossary/load-testing/) — assess stability under expected load. +- [Performance Testing](/docs/concepts/reference/glossary/performance-testing/) — reliability builds on performance results. +- [Observability Testing](/docs/concepts/reference/glossary/observability-testing/) — monitor failures and recovery over time. +- [Browse all testing terms](/docs/concepts/reference/glossary/) — the full Keploy glossary. + ## Frequently Asked Questions ### 1. What is the difference between reliability testing and performance testing? diff --git a/versioned_docs/version-4.0.0/concepts/reference/glossary/software-testing-life-cycle.md b/versioned_docs/version-4.0.0/concepts/reference/glossary/software-testing-life-cycle.md index 634165238..6ee52e7a7 100644 --- a/versioned_docs/version-4.0.0/concepts/reference/glossary/software-testing-life-cycle.md +++ b/versioned_docs/version-4.0.0/concepts/reference/glossary/software-testing-life-cycle.md @@ -83,6 +83,13 @@ Software Testing Life Cycle (STLC) is integral to ensuring software quality and Incorporating STLC best practices and leveraging advanced testing tools empower organizations to achieve higher quality standards, enhance customer satisfaction, and maintain competitive advantage in the dynamic software landscape. +## Related Terms + +- [Regression Testing](/docs/concepts/reference/glossary/regression-testing/) — a key phase within the STLC. +- [Defect Management](/docs/concepts/reference/glossary/defect-management/) — track defects reported during testing. +- [QA Automation](/docs/concepts/reference/glossary/qa-automation/) — automate STLC test execution phases. +- [Browse all testing terms](/docs/concepts/reference/glossary/) — the full Keploy glossary. + ## FAQs ### 1. **What are the key phases of the Software Testing Life Cycle?** diff --git a/versioned_docs/version-4.0.0/concepts/reference/glossary/stubs.md b/versioned_docs/version-4.0.0/concepts/reference/glossary/stubs.md index 7a6baf7b2..2690d7c2f 100644 --- a/versioned_docs/version-4.0.0/concepts/reference/glossary/stubs.md +++ b/versioned_docs/version-4.0.0/concepts/reference/glossary/stubs.md @@ -53,3 +53,10 @@ Keploy can generate dependency stubs in addition to the testcases by recording y Keploy recording API calls and replaying them using generated stubs Since the data stubs are generated based on the real-time capturing of API calls from your application, they will be from real-world scenarios. This can help to ensure that the mock data is accurate and that it represents the real data as closely as possible. As well as, it makes the data maintenance process easier by providing a same environment for testing. This can help to identify the source of bugs more easily. + +## Related Terms + +- [Mocks](/docs/concepts/reference/glossary/mocks/) — the closely related test double often paired with stubs. +- [Unit Testing](/docs/concepts/reference/glossary/unit-testing/) — stubs isolate the unit under test. +- [Integration Testing](/docs/concepts/reference/glossary/integration-testing/) — stub external systems between modules. +- [Browse all testing terms](/docs/concepts/reference/glossary/) — the full Keploy glossary. diff --git a/versioned_docs/version-4.0.0/concepts/reference/glossary/test-data-generation.md b/versioned_docs/version-4.0.0/concepts/reference/glossary/test-data-generation.md index c7fc7db16..07be4eea3 100644 --- a/versioned_docs/version-4.0.0/concepts/reference/glossary/test-data-generation.md +++ b/versioned_docs/version-4.0.0/concepts/reference/glossary/test-data-generation.md @@ -53,3 +53,10 @@ Keploy offers a comprehensive solution for test data generation, addressing the In conclusion, effective test data generation is essential for ensuring the reliability, accuracy, and performance of software applications. By leveraging automated solutions like Keploy, software development teams can overcome the challenges associated with manual test data management and streamline their testing processes. With Keploy's dynamic test data generation capabilities, teams can accelerate testing cycles, enhance testing coverage, and ultimately deliver high-quality software products to market faster and more efficiently. By embracing modern test data generation practices facilitated by tools like Keploy, organizations can stay ahead in today's competitive landscape and meet the ever-growing demands for software reliability and innovation. + +## Related Terms + +- [Data-Driven Testing](/docs/concepts/reference/glossary/data-driven-testing/) — feed generated data sets into tests. +- [Mocks](/docs/concepts/reference/glossary/mocks/) — synthetic data mocks stand in for real sources. +- [Test-Driven Development](/docs/concepts/reference/glossary/test-driven-development/) — generated data supports test-first workflows. +- [Browse all testing terms](/docs/concepts/reference/glossary/) — the full Keploy glossary. diff --git a/versioned_docs/version-4.0.0/concepts/reference/glossary/test-driven-development.md b/versioned_docs/version-4.0.0/concepts/reference/glossary/test-driven-development.md index 416c2e293..850480504 100644 --- a/versioned_docs/version-4.0.0/concepts/reference/glossary/test-driven-development.md +++ b/versioned_docs/version-4.0.0/concepts/reference/glossary/test-driven-development.md @@ -170,6 +170,14 @@ Implementing TDD comes with challenges that teams should be aware of: Test Driven Development (TDD) is a powerful methodology that fosters robust, maintainable, and reliable code. By writing tests before code, developers are forced to clarify requirements, catch bugs early, and design modular components that are easier to maintain and scale. While TDD has its challenges, its benefits in enhancing code quality, enabling safe refactoring, and integrating seamlessly with CI/CD pipelines (especially when paired with tools like Keploy) make it a valuable approach in modern software development. +## Related Terms + +- [Unit Testing](/docs/concepts/reference/glossary/unit-testing/) — TDD is driven by writing unit tests first. +- [Behaviour Driven Development](/docs/concepts/reference/glossary/behaviour-driven-development/) — a collaboration-focused alternative to TDD. +- [Code Coverage](/docs/concepts/reference/glossary/code-coverage/) — measure how much code your tests exercise. +- [Mocks](/docs/concepts/reference/glossary/mocks/) — isolate units while writing tests first. +- [Browse all testing terms](/docs/concepts/reference/glossary/) — the full Keploy glossary. + ## FAQ ### What is Test Driven Development (TDD)? diff --git a/versioned_docs/version-4.0.0/concepts/reference/glossary/unit-test-automation.md b/versioned_docs/version-4.0.0/concepts/reference/glossary/unit-test-automation.md index e90cff4cf..c03c503c8 100644 --- a/versioned_docs/version-4.0.0/concepts/reference/glossary/unit-test-automation.md +++ b/versioned_docs/version-4.0.0/concepts/reference/glossary/unit-test-automation.md @@ -145,6 +145,14 @@ TestNG is another testing framework for Java, designed to cover a broader range Unit test automation is a fundamental practice in modern software development. By implementing effective unit testing strategies and utilizing the right tools, developers can improve code quality, reduce bugs, and enhance the overall efficiency of their development processes. Whether you're a seasoned developer or new to coding, investing in unit test automation will pay dividends in the long run. +## Related Terms + +- [Unit Testing](/docs/concepts/reference/glossary/unit-testing/) — the practice being automated here. +- [Test-Driven Development](/docs/concepts/reference/glossary/test-driven-development/) — write automated unit tests first. +- [Mocks](/docs/concepts/reference/glossary/mocks/) — isolate units during automated tests. +- [JUnit](/docs/concepts/reference/glossary/junit/) — a popular unit test automation framework. +- [Browse all testing terms](/docs/concepts/reference/glossary/) — the full Keploy glossary. + ## Frequently Asked Questions (FAQ) ### What is the difference between unit testing and integration testing? diff --git a/versioned_docs/version-4.0.0/concepts/reference/glossary/unit-testing.md b/versioned_docs/version-4.0.0/concepts/reference/glossary/unit-testing.md index 2da1aa7a6..b7e330b03 100644 --- a/versioned_docs/version-4.0.0/concepts/reference/glossary/unit-testing.md +++ b/versioned_docs/version-4.0.0/concepts/reference/glossary/unit-testing.md @@ -82,6 +82,14 @@ Keploy enhances the unit testing process by providing automated test case genera By incorporating Keploy into their testing workflows, developers can detect errors early in the development process, ensure comprehensive test coverage, and collaborate effectively with their teams to drive continuous improvement in testing practices. With its innovative features and seamless integration capabilities, Keploy empowers developers to write better code and deliver high-quality software products with confidence. +## Related Terms + +- [Unit Test Automation](/docs/concepts/reference/glossary/unit-test-automation/) — automate running your unit tests. +- [Test-Driven Development](/docs/concepts/reference/glossary/test-driven-development/) — write unit tests before code. +- [Mocks](/docs/concepts/reference/glossary/mocks/) — isolate the unit under test. +- [Integration Testing](/docs/concepts/reference/glossary/integration-testing/) — verify units work together. +- [Browse all testing terms](/docs/concepts/reference/glossary/) — the full Keploy glossary. + ## FAQs ### 1. **What is Unit Testing?** diff --git a/versioned_docs/version-4.0.0/concepts/reference/glossary/visual-regression-testing.md b/versioned_docs/version-4.0.0/concepts/reference/glossary/visual-regression-testing.md index 40f6c9d7b..01e3c5865 100644 --- a/versioned_docs/version-4.0.0/concepts/reference/glossary/visual-regression-testing.md +++ b/versioned_docs/version-4.0.0/concepts/reference/glossary/visual-regression-testing.md @@ -151,6 +151,13 @@ Visual regression testing continues to evolve as applications become more comple **Performance-Aware Visual Testing**: Future visual regression testing will integrate performance considerations, ensuring that visual quality improvements don't come at the expense of application performance. +## Related Terms + +- [Regression Testing](/docs/concepts/reference/glossary/regression-testing/) — visual regression is a specialized form of it. +- [Functional Testing](/docs/concepts/reference/glossary/functional-testing/) — complements visual checks with behavior validation. +- [Component Testing](/docs/concepts/reference/glossary/component-testing/) — test isolated UI components visually. +- [Browse all testing terms](/docs/concepts/reference/glossary/) — the full Keploy glossary. + ## Frequently Asked Questions ### Q: Can Keploy handle dynamic content and API-dependent visual states in regression testing? diff --git a/versioned_docs/version-4.0.0/concepts/reference/glossary/white-box-testing.md b/versioned_docs/version-4.0.0/concepts/reference/glossary/white-box-testing.md index 2d0600ba0..529796dcb 100644 --- a/versioned_docs/version-4.0.0/concepts/reference/glossary/white-box-testing.md +++ b/versioned_docs/version-4.0.0/concepts/reference/glossary/white-box-testing.md @@ -119,6 +119,14 @@ Firstly, install [Keploy](https://keploy.io/), a testing tool that helps you aut White box testing is invaluable for uncovering hidden errors and optimizing performance. While it requires technical expertise, its thorough approach ensures robust, secure, and high-performing software. Combining white box testing with black box testing offers comprehensive coverage, enhancing the overall quality of your applications. +## Related Terms + +- [Black Box Testing](/docs/concepts/reference/glossary/black-box-testing/) — the opposite approach with no internal knowledge. +- [Grey Box Testing](/docs/concepts/reference/glossary/gray-box-testing/) — a hybrid of white and black box testing. +- [Code Coverage](/docs/concepts/reference/glossary/code-coverage/) — measure which code paths tests exercise. +- [Unit Testing](/docs/concepts/reference/glossary/unit-testing/) — a common white box technique. +- [Browse all testing terms](/docs/concepts/reference/glossary/) — the full Keploy glossary. + ## FAQs ### What is white box testing? From 3104c08b796d8e0142b0045e2c9b3046328e0537 Mon Sep 17 00:00:00 2001 From: dhananjay6561 Date: Mon, 10 Aug 2026 19:10:12 +0530 Subject: [PATCH 17/26] docs(A4): add "Related" cross-links to running-keploy docs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Add a "Related" section (3–4 contextual internal links) to running-keploy feature docs that had only one internal link. Links use each page real route slug, verified by a clean build under onBrokenLinks: throw. Signed-off-by: dhananjay6561 --- .../running-keploy/about-api-testing.md | 7 +++ .../running-keploy/about-unit-testing.md | 6 ++ .../running-keploy/agent-test-generation.md | 7 +++ .../running-keploy/api-test-architecture.md | 7 +++ .../running-keploy/api-testing-add-suite.md | 14 ++++- .../api-testing-adding-labels.md | 10 ++-- .../api-testing-assertion-tree.md | 43 ++++++++------ .../running-keploy/api-testing-auth-setup.md | 7 +++ .../api-testing-buggy-suites.md | 31 +++++++++- .../api-testing-bulk-assertions.md | 14 ++++- .../api-testing-chrome-extension.md | 7 +++ .../running-keploy/api-testing-cicd.md | 7 +++ .../api-testing-custom-assertions.md | 56 +++++++++++-------- .../api-testing-edit-assertions.md | 8 ++- .../running-keploy/api-testing-edit-suites.md | 8 +++ .../api-testing-filter-suites.md | 17 +++++- .../running-keploy/api-testing-fixing-ai.md | 27 ++++++--- .../running-keploy/api-testing-functions.md | 7 +++ .../api-testing-generation-history.md | 16 +++++- .../running-keploy/api-testing-local-agent.md | 14 ++++- .../api-testing-mark-unbuggy.md | 13 ++++- .../running-keploy/api-testing-run-report.md | 28 ++++++++-- .../api-testing-schema-coverage.md | 18 +++++- .../api-testing-sharing-reports.md | 7 +++ .../api-testing-tool-ai-powered.md | 7 +++ .../running-keploy/api-testing-variables.md | 7 +++ .../running-keploy/api-testing-webhook.md | 7 +++ .../best-practices-api-testing.md | 7 +++ .../running-keploy/cli-commands.md | 7 +++ .../running-keploy/configuration-file.md | 7 +++ .../running-keploy/custom-mocks.md | 7 +++ .../running-keploy/docker-tls.md | 7 +++ .../generate-api-tests-using-ai.md | 7 +++ .../k8s-proxy-daemonset-architecture.md | 6 ++ .../running-keploy/keploy-karaf.md | 7 +++ .../running-keploy/keploy-passthrough.md | 6 ++ .../running-keploy/keploy-templatize.md | 6 ++ .../running-keploy/recording-filters.md | 50 +++++++++-------- .../running-keploy/rename-testcases.md | 6 ++ .../review-and-improve-ai-generated-tests.md | 6 ++ .../running-keploy/risk-profile-analysis.md | 6 ++ .../run-ai-generated-api-tests.md | 6 ++ .../self-healing-ai-api-tests.md | 8 ++- .../running-keploy/share-tests.md | 6 ++ .../running-keploy/test-generate.md | 6 ++ .../running-keploy/test-run-reports.md | 6 ++ .../running-keploy/unit-test-architecture.md | 6 ++ .../running-keploy/unit-test-generator.md | 6 ++ .../running-keploy/utg-pr-agent.md | 6 ++ .../running-keploy/utg-vsc-extension.md | 6 ++ 50 files changed, 491 insertions(+), 100 deletions(-) diff --git a/versioned_docs/version-4.0.0/running-keploy/about-api-testing.md b/versioned_docs/version-4.0.0/running-keploy/about-api-testing.md index 02f9f7171..5c14597f7 100644 --- a/versioned_docs/version-4.0.0/running-keploy/about-api-testing.md +++ b/versioned_docs/version-4.0.0/running-keploy/about-api-testing.md @@ -64,3 +64,10 @@ APIs act as the _bridge_ between different software systems — enabling communi - Testing across multiple environments (dev, staging, prod) - Ensuring version compatibility and backward support - Automating complex workflows involving chained API calls + +## Related + +- [API Test Architecture](/docs/running-keploy/api-test-architecture/) — how Keploy generates API tests. +- [API Test Generator](/docs/running-keploy/api-test-generator/) — generate API test suites with AI. +- [What is Unit Testing?](/docs/running-keploy/about-unit-testing/) — compare with unit testing basics. +- [Best Practices for API testing](/docs/running-keploy/best-practices-api-testing/) — recommended API testing practices. diff --git a/versioned_docs/version-4.0.0/running-keploy/about-unit-testing.md b/versioned_docs/version-4.0.0/running-keploy/about-unit-testing.md index 276b7cd72..45231c302 100644 --- a/versioned_docs/version-4.0.0/running-keploy/about-unit-testing.md +++ b/versioned_docs/version-4.0.0/running-keploy/about-unit-testing.md @@ -34,3 +34,9 @@ Think of it as checking each LEGO brick before building the whole castle. - **Flaky Tests:** Unstable tests that sometimes pass, sometimes fail (super annoying). - **Coverage Gaps:** Missing tests for edge cases or tricky logic. - **Maintenance:** Keeping tests up to date as code evolves. + +## Related + +- [Unit Test Architecture](/docs/running-keploy/unit-test-architecture/) — how Keploy builds unit tests. +- [Keploy Unit Test Generator](/docs/running-keploy/unit-test-generator/) — generate unit tests automatically. +- [What is API testing?](/docs/running-keploy/about-api-testing/) — compare with API testing basics. diff --git a/versioned_docs/version-4.0.0/running-keploy/agent-test-generation.md b/versioned_docs/version-4.0.0/running-keploy/agent-test-generation.md index da6496a19..d88c9ac99 100644 --- a/versioned_docs/version-4.0.0/running-keploy/agent-test-generation.md +++ b/versioned_docs/version-4.0.0/running-keploy/agent-test-generation.md @@ -430,3 +430,10 @@ When `--spec` is provided, every `run` output includes a `coverage` section: The agent reads `next_steps` and generates targeted tests for uncovered endpoints. This loop continues automatically until coverage targets are met. Without an OpenAPI spec, you can still run tests and sync results. The Keploy platform builds schema coverage progressively from your test execution data over time. + +## Related + +- [Generate API Tests using AI](/docs/running-keploy/generate-api-tests-using-ai/) — generate API tests with AI. +- [AI-Powered API Test Generation](/docs/running-keploy/test-generate/) — AI-powered test generation workflow. +- [Run AI-Generated API Tests](/docs/running-keploy/run-ai-generated-api-tests/) — run the generated tests. +- [API Test Generator](/docs/running-keploy/api-test-generator/) — how AI test generation works. diff --git a/versioned_docs/version-4.0.0/running-keploy/api-test-architecture.md b/versioned_docs/version-4.0.0/running-keploy/api-test-architecture.md index 581292212..fad82a191 100644 --- a/versioned_docs/version-4.0.0/running-keploy/api-test-architecture.md +++ b/versioned_docs/version-4.0.0/running-keploy/api-test-architecture.md @@ -49,3 +49,10 @@ Keploy needs to interact with your live API endpoints to generate and validate t Ready to try it? [app.keploy.io](https://app.keploy.io) Questions? [Contact our team](mailto:support@keploy.io). + +## Related + +- [What is API testing?](/docs/running-keploy/about-api-testing/) — understand API testing fundamentals. +- [API Test Generator](/docs/running-keploy/api-test-generator/) — generate test suites with AI. +- [Authentication Setup for API Testing](/docs/running-keploy/api-testing-auth-setup/) — configure auth before generation. +- [Best Practices for API testing](/docs/running-keploy/best-practices-api-testing/) — recommended API testing practices. diff --git a/versioned_docs/version-4.0.0/running-keploy/api-testing-add-suite.md b/versioned_docs/version-4.0.0/running-keploy/api-testing-add-suite.md index 154a2575f..23917ab0b 100644 --- a/versioned_docs/version-4.0.0/running-keploy/api-testing-add-suite.md +++ b/versioned_docs/version-4.0.0/running-keploy/api-testing-add-suite.md @@ -9,6 +9,7 @@ tags: - test-suite - test-management --- + import ProductTier from '@site/src/components/ProductTier'; @@ -27,7 +28,7 @@ In this guide, we will walk through the process of adding a test suite in Keploy - **Details**: Provide a brief description of the test suite. - **Request**: Specify the request details, such as the HTTP method, URL, headers, and body. - **Assertions**: Define any Assertions related to the test suite. -![Add Suite](https://keploy-devrel.s3.us-west-2.amazonaws.com/add-new-suite-1.png) + ![Add Suite](https://keploy-devrel.s3.us-west-2.amazonaws.com/add-new-suite-1.png) 3. **Import a Curl Command (Optional)** - If you have a curl command, you can directly import it to create the test suite. @@ -40,6 +41,7 @@ In this guide, we will walk through the process of adding a test suite in Keploy ## Example ### Manual Entry + ```json { "name": "User Authentication", @@ -59,10 +61,18 @@ In this guide, we will walk through the process of adding a test suite in Keploy ``` ### Importing a Curl Command + ```bash curl -X POST https://api.example.com/login \ -H "Content-Type: application/json" \ -d '{"username": "test_user", "password": "secure_password"}' ``` -By following these steps, you can easily create and manage test suites in Keploy. \ No newline at end of file +By following these steps, you can easily create and manage test suites in Keploy. + +## Related + +- [Edit Test Suites](/docs/running-keploy/api-testing-edit-suites/) — edit suites after creating them. +- [Test Suite Settings & Actions](/docs/running-keploy/api-testing-suite-settings/) — manage suite settings and actions. +- [Adding Labels to Test Suites](/docs/running-keploy/api-testing-adding-labels/) — organize new suites with labels. +- [Using Filtering in Test Suites](/docs/running-keploy/api-testing-filter-suites/) — filter across your test suites. diff --git a/versioned_docs/version-4.0.0/running-keploy/api-testing-adding-labels.md b/versioned_docs/version-4.0.0/running-keploy/api-testing-adding-labels.md index de7c2a91c..ed8aa6b37 100644 --- a/versioned_docs/version-4.0.0/running-keploy/api-testing-adding-labels.md +++ b/versioned_docs/version-4.0.0/running-keploy/api-testing-adding-labels.md @@ -46,6 +46,7 @@ The labeling system includes: When you open the label assignment dialog, you'll see: ### Existing Labels Section + ``` 🏷️ Available Labels ├── 📊 Priority @@ -77,11 +78,11 @@ When you open the label assignment dialog, you'll see: - Follow the steps above to open the label assignment interface 2. **Create New Label** - - Click **"Create Custom Label"** + - Click **"Create Custom Label"** - Enter label details in the creation form 3. **Label Creation Form** - - For Example: + - For Example: ``` Label Name: [smoke-critical] Color: [🔴] (color picker) @@ -101,13 +102,14 @@ When you open the label assignment dialog, you'll see: ### Naming Conventions 1. **Use Consistent Formatting** + ``` ✅ Good Examples: - team-frontend - priority-high - env-production - type-smoke-test - + ❌ Avoid: - TeamFrontend - HIGH_PRIORITY @@ -131,4 +133,4 @@ When you open the label assignment dialog, you'll see: - **[Test Reports](./api-testing-sharing-reports.md)**: Generate reports filtered by labels - **[Custom Assertions](./api-testing-custom-assertions.md)**: Create assertions for labeled suites -Labels are a powerful organizational tool that help you maintain order in large test collections and enable efficient test management workflows. \ No newline at end of file +Labels are a powerful organizational tool that help you maintain order in large test collections and enable efficient test management workflows. diff --git a/versioned_docs/version-4.0.0/running-keploy/api-testing-assertion-tree.md b/versioned_docs/version-4.0.0/running-keploy/api-testing-assertion-tree.md index a89527c4b..1352fcbfb 100644 --- a/versioned_docs/version-4.0.0/running-keploy/api-testing-assertion-tree.md +++ b/versioned_docs/version-4.0.0/running-keploy/api-testing-assertion-tree.md @@ -36,21 +36,22 @@ Instead of viewing tests as isolated steps, the Assertion Tree gives you a compl 3. The system renders the full test suite in a **tree format** --- + ![Assertion tree](https://keploy-devrel.s3.us-west-2.amazonaws.com/assertion-tree-1.png) ## What You Can See The Assertion Tree provides a visual representation of: -- All test steps in execution order -- Request details for each step -- Attached assertions +- All test steps in execution order +- Request details for each step +- Attached assertions Each node in the tree represents a test step and contains: -- Request configuration -- Associated assertions -- Execution dependencies +- Request configuration +- Associated assertions +- Execution dependencies This makes it easier to understand how your test suite behaves as a complete workflow. @@ -59,16 +60,18 @@ This makes it easier to understand how your test suite behaves as a complete wor The Assertion Tree is fully interactive. You can: ### 1. View Complete Flow + Understand the entire API workflow from start to finish without switching between screens. ### 2. Inspect Assertions Inline + Quickly see which assertions are attached to each step, including: -- Status code validations -- JSON validations -- Header validations -- Schema validations -- Custom function validations +- Status code validations +- JSON validations +- Header validations +- Schema validations +- Custom function validations ### 3. Add a New Step in the Flow @@ -97,11 +100,11 @@ It transforms test management from a flat list into a structured execution graph ## Typical Use Cases -- Authentication → Resource Creation → Validation → Cleanup flows -- Multi-step payment processing validations -- E-commerce checkout journeys -- Webhook-triggered event testing -- Integration testing across services +- Authentication → Resource Creation → Validation → Cleanup flows +- Multi-step payment processing validations +- E-commerce checkout journeys +- Webhook-triggered event testing +- Integration testing across services ## Best Practices @@ -111,5 +114,11 @@ It transforms test management from a flat list into a structured execution graph - Review flow dependencies to avoid unintended execution order - Use visualization to debug failing multi-step tests faster - The Assertion Tree enables you to design, inspect, and extend complex API workflows with clarity and precision — all from a single visual interface. + +## Related + +- [Custom Assertions](/docs/running-keploy/api-testing-custom-assertions/) — define validation rules. +- [Functions & Schema Assertions](/docs/running-keploy/api-testing-functions/) — schema and function assertions. +- [Editing Test Suites and Custom Assertions](/docs/running-keploy/api-testing-edit-assertions/) — edit assertions in a suite. +- [Bulk Assertions and Schema Validation](/docs/running-keploy/api-testing-bulk-assertions/) — apply assertions in bulk. diff --git a/versioned_docs/version-4.0.0/running-keploy/api-testing-auth-setup.md b/versioned_docs/version-4.0.0/running-keploy/api-testing-auth-setup.md index 7b229d653..c925b28f1 100644 --- a/versioned_docs/version-4.0.0/running-keploy/api-testing-auth-setup.md +++ b/versioned_docs/version-4.0.0/running-keploy/api-testing-auth-setup.md @@ -41,3 +41,10 @@ Cookie - Keploy will execute this API and take the cookie from response headers ![Keploy](../../../static/img/jwt.png) This Auth option is for the application which can be authenticated using jwt token. This token is used in all the API calls that are done by Keploy to the application. + +## Related + +- [Adding New Test Suites](/docs/running-keploy/api-testing-add-suite/) — add suites for protected endpoints. +- [Using Keploy Local Agent](/docs/running-keploy/api-testing-local-agent/) — test private endpoints locally. +- [API Test Generator](/docs/running-keploy/api-test-generator/) — generate tests after auth setup. +- [API Test Recorder (Chrome Extension)](/docs/running-keploy/api-testing-chrome-extension/) — capture authenticated traffic. diff --git a/versioned_docs/version-4.0.0/running-keploy/api-testing-buggy-suites.md b/versioned_docs/version-4.0.0/running-keploy/api-testing-buggy-suites.md index 31f3289fe..104423f57 100644 --- a/versioned_docs/version-4.0.0/running-keploy/api-testing-buggy-suites.md +++ b/versioned_docs/version-4.0.0/running-keploy/api-testing-buggy-suites.md @@ -9,6 +9,7 @@ tags: - test-failures - troubleshooting --- + import ProductTier from '@site/src/components/ProductTier'; @@ -20,8 +21,8 @@ When Keploy generates tests, some test cases might fail due to various reasons s Navigate to the test suites generated with the red exclamation icon to view all test suites that contain failing test cases. Each buggy suite displays: - **Suite Name**: The name of the test suite containing failed tests -- **Test Steps**: Steps in the suite -- **Failure Reason**: Reason why the test suite is buggy +- **Test Steps**: Steps in the suite +- **Failure Reason**: Reason why the test suite is buggy ## Understanding Failure Reasons @@ -30,16 +31,19 @@ For each buggy test suite, you can find the detailed explanations of why tests a ### 1. Endpoint Not Found (404 Errors) **Example Failure Reason:** + ``` The response returned a 404 status code for the 'Create Owner' step, indicating the endpoint '/owners' was not found. This contradicts the documented cURL examples and schema, which show that this endpoint should exist and return a 201 status code upon successful creation. ``` **What this means:** + - The API endpoint that was working during recording is no longer available - The endpoint URL might have changed - The API server might be down or misconfigured **How to fix:** + 1. Verify the endpoint URL is correct 2. Check if the API server is running 3. Review API documentation for any endpoint changes @@ -48,11 +52,13 @@ The response returned a 404 status code for the 'Create Owner' step, indicating ### 2. Schema Validation Failures **Example Failure Reason:** + ``` Response schema validation failed. Expected property 'id' of type 'number' but received 'string'. The API response structure has changed from the recorded version. ``` **What this means:** + - The API response format has changed since recording - Data types don't match the expected schema - New required fields might have been added @@ -60,11 +66,13 @@ Response schema validation failed. Expected property 'id' of type 'number' but r ### 3. Authentication Issues **Example Failure Reason:** + ``` Authentication failed with 401 Unauthorized. The API key or token used during recording may have expired or been revoked. ``` **What this means:** + - API credentials have expired or changed - Authentication method has been updated - Permission levels may have changed @@ -74,6 +82,7 @@ Authentication failed with 401 Unauthorized. The API key or token used during re The buggy suites page provides detailed assertion failure information to help you understand exactly what went wrong: ### Response Status Assertions + ```yaml Expected: 201 Created Actual: 404 Not Found @@ -82,6 +91,7 @@ Message: The endpoint returned an unexpected status code ``` ### Response Body Assertions + ```yaml Expected: {"id": 123, "name": "John Doe", "email": "john@example.com"} Actual: {"error": "User not found", "code": 404} @@ -94,19 +104,25 @@ Message: Response body structure completely different from expected For each buggy test case, you can take several debugging actions: ### 1. View Full Test Details + Click on any failed test to see: + - Complete request details (URL, headers, body) - Full response details (status, headers, body) - All assertion results with expected vs actual values ### 2. Compare with Recorded Version + View the side-by-side comparison between: + - **Original Recording**: The request/response captured during recording - **Current Execution**: The actual request/response during test execution - **Differences Highlighted**: Visual indicators showing what changed ### 3. Manual Test Execution + Test the endpoint manually to verify: + ```bash # Example manual cURL test curl -X POST \ @@ -120,7 +136,9 @@ curl -X POST \ ``` ### 4. Update Test Expectations + If the API behavior has legitimately changed: + 1. **Re-record the test**: Capture new expected behavior 2. **Update assertions**: Modify expected values to match new API 3. **Add new test cases**: Cover additional scenarios if needed @@ -134,4 +152,11 @@ If you're unable to resolve buggy test suites: 3. **Community Forums**: Ask questions in Keploy community channels 4. **Share Test Details**: Provide complete test execution logs when seeking help -Remember, buggy test suites often indicate real issues with your API or environment. Use them as an early warning system to maintain API quality and reliability. \ No newline at end of file +Remember, buggy test suites often indicate real issues with your API or environment. Use them as an early warning system to maintain API quality and reliability. + +## Related + +- [Mark Test Suite as Unbuggy](/docs/running-keploy/api-testing-mark-unbuggy/) — mark suites fixed as unbuggy. +- [Fix with AI](/docs/running-keploy/api-testing-fix-with-ai/) — auto-repair failing suites. +- [Test Run Reports](/docs/running-keploy/api-testing-run-report/) — review failures in run reports. +- [Edit Test Suites](/docs/running-keploy/api-testing-edit-suites/) — manually fix suite issues. diff --git a/versioned_docs/version-4.0.0/running-keploy/api-testing-bulk-assertions.md b/versioned_docs/version-4.0.0/running-keploy/api-testing-bulk-assertions.md index 11300bd9f..77a655e06 100644 --- a/versioned_docs/version-4.0.0/running-keploy/api-testing-bulk-assertions.md +++ b/versioned_docs/version-4.0.0/running-keploy/api-testing-bulk-assertions.md @@ -26,6 +26,7 @@ Schema assertions allow you to validate the structure and format of API response ### 1. Filter Your Test Suites First, use the filtering options to narrow down the tests you want to assert: + - **Filter by Endpoint**: Select specific API endpoints - **Filter by HTTP Method**: Choose methods like GET, POST, PUT, DELETE, etc. - **Filter by Status Code**: Filter by response status codes (2xx, 4xx, 5xx, etc.) @@ -35,6 +36,7 @@ First, use the filtering options to narrow down the tests you want to assert: Select the configure schema assertions option From the entire response body, you can choose which fields to assert: + - **Response Body Fields**: Select individual fields from the JSON response - **Data Types**: Ensure fields have correct types (string, number, boolean, etc.) - **Required Fields**: Verify that mandatory fields are present @@ -42,6 +44,7 @@ From the entire response body, you can choose which fields to assert: ### 4. Apply Schema Assertions Schema assertions validate the structure of your API responses: + - **Field Presence**: Ensure required fields exist in the response - **Data Type Validation**: Verify that fields have the correct data type - **Format Validation**: Check formats like email, URL, date, etc. @@ -55,6 +58,7 @@ Schema assertions validate the structure of your API responses: ## Example Use Cases ### Example: Asserting User Endpoints + ``` Filter by: - Endpoint: /api/v1/users/* @@ -67,7 +71,6 @@ Bulk Assert: - Email format validation ``` - ## Benefits of Bulk Assertions - **Time Efficiency**: Apply assertions to multiple tests simultaneously @@ -82,4 +85,11 @@ Bulk Assert: - **Use realistic data**: Test with production-like data for accurate validation - **Regular updates**: Update schemas when API contracts change -By leveraging bulk assertions and schema validation, you can ensure comprehensive API testing while minimizing manual effort and maintaining high test coverage across your application. \ No newline at end of file +By leveraging bulk assertions and schema validation, you can ensure comprehensive API testing while minimizing manual effort and maintaining high test coverage across your application. + +## Related + +- [Custom Assertions](/docs/running-keploy/api-testing-custom-assertions/) — define individual assertions. +- [Functions & Schema Assertions](/docs/running-keploy/api-testing-functions/) — schema and function assertions. +- [Using Filtering in Test Suites](/docs/running-keploy/api-testing-filter-suites/) — filter suites before asserting. +- [Assertion Tree](/docs/running-keploy/api-testing-assertion-tree/) — visualize assertion flow. diff --git a/versioned_docs/version-4.0.0/running-keploy/api-testing-chrome-extension.md b/versioned_docs/version-4.0.0/running-keploy/api-testing-chrome-extension.md index 64c8f8dcb..dac5179d8 100644 --- a/versioned_docs/version-4.0.0/running-keploy/api-testing-chrome-extension.md +++ b/versioned_docs/version-4.0.0/running-keploy/api-testing-chrome-extension.md @@ -94,3 +94,10 @@ Records repaired: 15 | ------------------------------------------------------------ | -------------------------------------------- | ------------------------------------------------------------------ | | `Captured calls` increments, but `Complete req/resp` stays 0 | Responses blocked by CORS or Service Worker. | Click **Debug**, or whitelist the domain in extension permissions. | | “Network error” when pressing **Generate Tests** | Auth token expired. | Log out, log back in. | + +## Related + +- [Using Keploy Local Agent](/docs/running-keploy/api-testing-local-agent/) — alternative for local endpoints. +- [Adding New Test Suites](/docs/running-keploy/api-testing-add-suite/) — create suites from captured calls. +- [API Test Generator](/docs/running-keploy/api-test-generator/) — generate tests from traffic. +- [Authentication Setup for API Testing](/docs/running-keploy/api-testing-auth-setup/) — handle authenticated replay. diff --git a/versioned_docs/version-4.0.0/running-keploy/api-testing-cicd.md b/versioned_docs/version-4.0.0/running-keploy/api-testing-cicd.md index 7aea26509..4c39abc14 100644 --- a/versioned_docs/version-4.0.0/running-keploy/api-testing-cicd.md +++ b/versioned_docs/version-4.0.0/running-keploy/api-testing-cicd.md @@ -96,3 +96,10 @@ Failed suites: 0 ## That's it! With just a few lines of YAML, you’ve added **AI-powered API test automation** into your GitHub CI pipeline. Now every PR or deployment will be automatically tested with Keploy’s smart test engine. + +## Related + +- [Test Run Reports](/docs/running-keploy/api-testing-run-report/) — review CI test run reports. +- [Test Suite Settings & Actions](/docs/running-keploy/api-testing-suite-settings/) — configure run-in-CI settings. +- [Running Selective Test Suites](/docs/running-keploy/api-testing-running-selective/) — run selected suites in CI. +- [Sharing Reports](/docs/running-keploy/api-testing-sharing-reports/) — share CI results with team. diff --git a/versioned_docs/version-4.0.0/running-keploy/api-testing-custom-assertions.md b/versioned_docs/version-4.0.0/running-keploy/api-testing-custom-assertions.md index 7a934d0ec..8cb325f6c 100644 --- a/versioned_docs/version-4.0.0/running-keploy/api-testing-custom-assertions.md +++ b/versioned_docs/version-4.0.0/running-keploy/api-testing-custom-assertions.md @@ -15,7 +15,6 @@ keywords: - header validation - schema validation - custom functions - --- import ProductTier from '@site/src/components/ProductTier'; @@ -26,24 +25,25 @@ Custom assertions allow you to precisely validate API responses beyond basic sta Keploy supports the following assertion categories: -| Scenario | Recommended Assertion | -|----------|----------------------| -| Exact status code validation | Status Code | -| Accept any success response | Status Code Class | -| Partial JSON validation | JSON Contains | -| Strict field validation | JSON Equal | -| Response structure consistency | Schema | -| Dynamic value comparison | Custom Function | -| Validate only important fields | Selected Fields | -| Security header enforcement | Header Exists / Header Equal | - +| Scenario | Recommended Assertion | +| ------------------------------ | ---------------------------- | +| Exact status code validation | Status Code | +| Accept any success response | Status Code Class | +| Partial JSON validation | JSON Contains | +| Strict field validation | JSON Equal | +| Response structure consistency | Schema | +| Dynamic value comparison | Custom Function | +| Validate only important fields | Selected Fields | +| Security header enforcement | Header Exists / Header Equal | ## For specific Selected Fields ### Selected Fields + Allows you to validate only specific parts of a response instead of the entire body. Useful when: + - Response includes dynamic metadata - You want to ignore volatile fields (timestamps, request IDs, etc.) - Only certain business-critical fields matter @@ -53,6 +53,7 @@ Useful when: For complex validation logic, Keploy supports custom functions inside assertions. Custom functions allow you to: + - Write JavaScript expressions - Perform conditional validation - Compare multiple fields @@ -60,6 +61,7 @@ Custom functions allow you to: - Enforce business rules ### Example Use Cases + - Validate `totalAmount = sum(lineItems)` - Ensure timestamp is within last 5 minutes - Compare response field with environment variable @@ -70,31 +72,33 @@ Custom functions allow you to: Consider an e-commerce API that returns order details. You want to validate that the total amount equals the sum of all line items plus tax. **API Response:** + ```json { "orderId": "ORD-12345", "items": [ - { "name": "Laptop", "price": 1200.00, "quantity": 1 }, - { "name": "Mouse", "price": 25.50, "quantity": 2 } + {"name": "Laptop", "price": 1200.0, "quantity": 1}, + {"name": "Mouse", "price": 25.5, "quantity": 2} ], - "subtotal": 1251.00, - "tax": 125.10, - "total": 1376.10, + "subtotal": 1251.0, + "tax": 125.1, + "total": 1376.1, "timestamp": "2026-02-11T10:30:00Z" } ``` **Custom Function for Total Validation:** + ```javascript // Validate that total = subtotal + tax function validateOrderTotal(response) { const data = JSON.parse(response.body); const expectedTotal = data.subtotal + data.tax; const actualTotal = data.total; - + return { passed: Math.abs(expectedTotal - actualTotal) < 0.01, // Handle floating point precision - message: `Expected total ${expectedTotal}, but got ${actualTotal}` + message: `Expected total ${expectedTotal}, but got ${actualTotal}`, }; } @@ -102,17 +106,18 @@ function validateOrderTotal(response) { function validateSubtotal(response) { const data = JSON.parse(response.body); const calculatedSubtotal = data.items.reduce((sum, item) => { - return sum + (item.price * item.quantity); + return sum + item.price * item.quantity; }, 0); - + return { passed: Math.abs(calculatedSubtotal - data.subtotal) < 0.01, - message: `Calculated subtotal ${calculatedSubtotal}, but API returned ${data.subtotal}` + message: `Calculated subtotal ${calculatedSubtotal}, but API returned ${data.subtotal}`, }; } ``` **Usage in Keploy:** + 1. Navigate to your test step editor 2. Add a new assertion 3. Select "Custom Function" as assertion type @@ -127,3 +132,10 @@ function validateSubtotal(response) { - **Use Custom Functions** for business logic validation - **Combine multiple assertions** for stronger test reliability - **Keep assertions focused and readable** + +## Related + +- [Functions & Schema Assertions](/docs/running-keploy/api-testing-functions/) — schema and function assertions. +- [Bulk Assertions and Schema Validation](/docs/running-keploy/api-testing-bulk-assertions/) — apply assertions in bulk. +- [Editing Test Suites and Custom Assertions](/docs/running-keploy/api-testing-edit-assertions/) — edit assertions in a suite. +- [Assertion Tree](/docs/running-keploy/api-testing-assertion-tree/) — visualize assertion flow. diff --git a/versioned_docs/version-4.0.0/running-keploy/api-testing-edit-assertions.md b/versioned_docs/version-4.0.0/running-keploy/api-testing-edit-assertions.md index 429de14d2..fad4c26c7 100644 --- a/versioned_docs/version-4.0.0/running-keploy/api-testing-edit-assertions.md +++ b/versioned_docs/version-4.0.0/running-keploy/api-testing-edit-assertions.md @@ -29,7 +29,6 @@ Editing a test suite allows you to: This gives you fine-grained control over how your APIs are validated. - ## Accessing Test Suite Edit Mode ### Step 1: Navigate to Test Suites @@ -64,10 +63,17 @@ You can: - Inject variables into any field ## Editing Existing Assertions + You can choose from multiple assertion categories: + - Status Code Assertion - Header Assertion - Body / JSON Path Assertion - Schema Assertion +## Related +- [Custom Assertions](/docs/running-keploy/api-testing-custom-assertions/) — define validation rules. +- [Functions & Schema Assertions](/docs/running-keploy/api-testing-functions/) — schema and function assertions. +- [Edit Test Suites](/docs/running-keploy/api-testing-edit-suites/) — edit suite request details. +- [Bulk Assertions and Schema Validation](/docs/running-keploy/api-testing-bulk-assertions/) — apply assertions in bulk. diff --git a/versioned_docs/version-4.0.0/running-keploy/api-testing-edit-suites.md b/versioned_docs/version-4.0.0/running-keploy/api-testing-edit-suites.md index 9b81c7d13..0e730a03f 100644 --- a/versioned_docs/version-4.0.0/running-keploy/api-testing-edit-suites.md +++ b/versioned_docs/version-4.0.0/running-keploy/api-testing-edit-suites.md @@ -63,6 +63,7 @@ Keploy supports custom functions for advanced assertion logic. You can: - Reference external validation logic For detailed information on custom functions, [reference here](/versioned_docs/version-4.0.0/running-keploy/api-testing-functions.md). + ### Creating and Using Variables Variables allow you to create reusable values across your test suite: @@ -81,3 +82,10 @@ For in detail usage of variables refer here : [Using Variables](/versioned_docs/ - **Group related tests**: Organize tests logically within suites (e.g., user authentication, payment processing, etc.) - **Keep suites focused**: Each test suite should test a specific feature or workflow - **Test multiple aspects**: Include assertions for status codes, response structure, and business logic + +## Related + +- [Adding New Test Suites](/docs/running-keploy/api-testing-add-suite/) — create suites to edit. +- [Test Suite Settings & Actions](/docs/running-keploy/api-testing-suite-settings/) — manage suite settings. +- [Editing Test Suites and Custom Assertions](/docs/running-keploy/api-testing-edit-assertions/) — edit assertions and variables. +- [Using Filtering in Test Suites](/docs/running-keploy/api-testing-filter-suites/) — filter suites while editing. diff --git a/versioned_docs/version-4.0.0/running-keploy/api-testing-filter-suites.md b/versioned_docs/version-4.0.0/running-keploy/api-testing-filter-suites.md index 3cea7f7df..727aaf459 100644 --- a/versioned_docs/version-4.0.0/running-keploy/api-testing-filter-suites.md +++ b/versioned_docs/version-4.0.0/running-keploy/api-testing-filter-suites.md @@ -1,7 +1,7 @@ --- id: api-testing-filter-suites title: Using Filtering in Test Suites -description: Guide to add filters for test suites +description: Guide to add filters for test suites sidebar_label: Filter Test Suites tags: - api-testing @@ -21,11 +21,13 @@ This guide explains how to filter test suites in Keploy to quickly find and mana Keploy provides multiple filtering options to help you efficiently locate and organize your test suites: ### 1. Filter by Test Suite + - Filter test suites by their name or identifier - Quickly locate specific test suites from a large collection - Use search functionality to find test suites by partial name matching ### 2. Filter by Status Code + - Filter tests based on HTTP response status codes - Common status code filters: - **2xx Success**: 200 OK, 201 Created, 204 No Content, etc. @@ -35,6 +37,7 @@ Keploy provides multiple filtering options to help you efficiently locate and or - Useful for identifying failing tests or specific response patterns ### 3. Filter by HTTP Method + - Filter tests based on the HTTP request method: - **GET**: Retrieve data from the server - **POST**: Submit data to create new resources @@ -46,6 +49,7 @@ Keploy provides multiple filtering options to help you efficiently locate and or - Helps organize tests by the type of operation being tested ### 4. Filter by Endpoint + - Filter tests based on the API endpoint or URL path - Search by: - Full endpoint URL @@ -62,9 +66,11 @@ Keploy provides multiple filtering options to help you efficiently locate and or ## Example Use Cases ### Finding Failed Tests + ``` Filter by Status Code: 4xx, 5xx ``` + This will show all tests that resulted in client or server errors. ## Benefits of Filtering @@ -75,4 +81,11 @@ This will show all tests that resulted in client or server errors. - **Test Analysis**: Understand patterns in your API behavior - **Maintenance**: Easier to update or remove tests for specific endpoints or methods -By using these filtering options, you can efficiently manage and analyze your test suites. \ No newline at end of file +By using these filtering options, you can efficiently manage and analyze your test suites. + +## Related + +- [Adding Labels to Test Suites](/docs/running-keploy/api-testing-adding-labels/) — filter using labels. +- [Running Selective Test Suites](/docs/running-keploy/api-testing-running-selective/) — run filtered suites. +- [Test Suite Settings & Actions](/docs/running-keploy/api-testing-suite-settings/) — manage suite settings. +- [Adding New Test Suites](/docs/running-keploy/api-testing-add-suite/) — add suites to filter. diff --git a/versioned_docs/version-4.0.0/running-keploy/api-testing-fixing-ai.md b/versioned_docs/version-4.0.0/running-keploy/api-testing-fixing-ai.md index de618d8b7..3c0d76570 100644 --- a/versioned_docs/version-4.0.0/running-keploy/api-testing-fixing-ai.md +++ b/versioned_docs/version-4.0.0/running-keploy/api-testing-fixing-ai.md @@ -51,6 +51,7 @@ Use this feature when: 3. Provide instructions describing what needs to be corrected Example instructions: + - "Normalize dynamic fields like timestamps and request IDs" - "Update schema based on latest API response" - "Ignore volatile metadata fields" @@ -66,13 +67,13 @@ Example instructions: The AI can intelligently update: -- JSON assertions -- Schema validations -- Header validations -- Status code expectations -- Dynamic field handling -- Selected field configurations -- Request payload mismatches +- JSON assertions +- Schema validations +- Header validations +- Status code expectations +- Dynamic field handling +- Selected field configurations +- Request payload mismatches It ensures the suite reflects the current API behavior while preserving intended validation logic. @@ -81,6 +82,7 @@ It ensures the suite reflects the current API behavior while preserving intended ## Example Scenario ### Problem + Your API now returns: ```json @@ -96,9 +98,11 @@ Previously, your test expected strict equality including `createdAt`. The test fails due to timestamp variance. ### Instruction to AI + "Normalize dynamic fields like `createdAt` and ignore timestamp differences." ### Result + AI updates the assertion to: - Use Schema validation instead of strict equality @@ -129,4 +133,11 @@ Normalization focuses on making tests stable without reducing meaningful validat - **Clearly mention which fields should be ignored or updated** - **Review AI-generated changes before finalizing** - **Use normalization for dynamic fields, not business logic errors** -- **Keep critical validations strict** \ No newline at end of file +- **Keep critical validations strict** + +## Related + +- [Buggy Test Suites](/docs/running-keploy/api-testing-buggy-suites/) — identify failing suites. +- [Mark Test Suite as Unbuggy](/docs/running-keploy/api-testing-mark-unbuggy/) — mark suites fixed as unbuggy. +- [Self-Healing API Tests](/docs/running-keploy/self-healing-ai-api-tests/) — self-healing test maintenance. +- [Edit Test Suites](/docs/running-keploy/api-testing-edit-suites/) — manually adjust suites. diff --git a/versioned_docs/version-4.0.0/running-keploy/api-testing-functions.md b/versioned_docs/version-4.0.0/running-keploy/api-testing-functions.md index 5adebce6f..f18ce878e 100644 --- a/versioned_docs/version-4.0.0/running-keploy/api-testing-functions.md +++ b/versioned_docs/version-4.0.0/running-keploy/api-testing-functions.md @@ -51,3 +51,10 @@ Save repeatable validation rules to the Global Custom Functions library so they Global Functions **Example Context:** The library shows reusable logic stored globally. For example, the `customFunction` at the bottom demonstrates an `assert.greater(response.status, 399)` utility, creating a standardized rule to verify error-level status codes across multiple suites. + +## Related + +- [Custom Assertions](/docs/running-keploy/api-testing-custom-assertions/) — define validation rules. +- [Bulk Assertions and Schema Validation](/docs/running-keploy/api-testing-bulk-assertions/) — apply assertions in bulk. +- [Assertion Tree](/docs/running-keploy/api-testing-assertion-tree/) — visualize assertion flow. +- [Editing Test Suites and Custom Assertions](/docs/running-keploy/api-testing-edit-assertions/) — edit assertions in a suite. diff --git a/versioned_docs/version-4.0.0/running-keploy/api-testing-generation-history.md b/versioned_docs/version-4.0.0/running-keploy/api-testing-generation-history.md index 1680855c2..db15c7c88 100644 --- a/versioned_docs/version-4.0.0/running-keploy/api-testing-generation-history.md +++ b/versioned_docs/version-4.0.0/running-keploy/api-testing-generation-history.md @@ -10,11 +10,12 @@ tags: - job-tracking - test-management --- + import ProductTier from '@site/src/components/ProductTier'; -This guide explains how to use the generation history to track and manage your test generation jobs. +This guide explains how to use the generation history to track and manage your test generation jobs. ## Generation History Features @@ -65,17 +66,20 @@ If you find rejected test suites that you want to include: ## Understanding Test Statuses ### Accepted Tests ✅ + - Tests that passed all validation checks - Successfully generated and ready to use - No issues detected in the test suite ### Rejected Tests ❌ + - Tests that failed validation checks - May have incorrect assertions or invalid configurations - Require manual review and fixes - Can be added back to the test suite list for modification ### Buggy Tests 🐛 + - Tests with identified bugs or issues - May have inconsistent behavior or errors - Need investigation and debugging @@ -130,16 +134,19 @@ If you find rejected test suites that you want to include: ## Analyzing Generation Trends ### Success Rate Analysis + - Track the percentage of accepted vs rejected tests over time - Identify patterns in test generation quality - Optimize inputs based on historical data ### Input Optimization + - Review which inputs led to higher acceptance rates - Compare different configurations and their outcomes - Refine your test generation strategy ### Error Patterns + - Identify common reasons for test rejection - Address recurring bugs or issues - Improve test generation quality @@ -170,3 +177,10 @@ If you find rejected test suites that you want to include: - Archive old generation jobs periodically - Focus on recent and relevant generations - Keep track of successful generation patterns + +## Related + +- [Schema Coverage and Generation](/docs/running-keploy/api-testing-schema-coverage/) — generate tests for coverage gaps. +- [API Test Generator](/docs/running-keploy/api-test-generator/) — how test generation works. +- [Test Run Reports](/docs/running-keploy/api-testing-run-report/) — review resulting run reports. +- [Adding New Test Suites](/docs/running-keploy/api-testing-add-suite/) — add suites manually. diff --git a/versioned_docs/version-4.0.0/running-keploy/api-testing-local-agent.md b/versioned_docs/version-4.0.0/running-keploy/api-testing-local-agent.md index 348196975..b94a67e66 100644 --- a/versioned_docs/version-4.0.0/running-keploy/api-testing-local-agent.md +++ b/versioned_docs/version-4.0.0/running-keploy/api-testing-local-agent.md @@ -9,6 +9,7 @@ tags: - test-suite - test-management --- + import ProductTier from '@site/src/components/ProductTier'; @@ -26,7 +27,7 @@ This guide explains how to use the local agent to test private or local endpoint - **Windows** - **Mac** - **Linux** -![Local Agent](https://keploy-devrel.s3.us-west-2.amazonaws.com/local-agent-1.png) + ![Local Agent](https://keploy-devrel.s3.us-west-2.amazonaws.com/local-agent-1.png) 3. **Start the Keploy Agent** - Once the agent is downloaded, start it on your device. @@ -40,6 +41,13 @@ This guide explains how to use the local agent to test private or local endpoint 5. **Troubleshooting Connection Issues** - Ensure that the agent is running and the endpoint URL is correct. - - If the local agent fails to connect, you can use the Keploy extension as an alternative [Record API Tests via Chrome Extension](https://keploy.io/docs/running-keploy/api-testing-chrome-extension/) + - If the local agent fails to connect, you can use the Keploy extension as an alternative [Record API Tests via Chrome Extension](https://keploy.io/docs/running-keploy/api-testing-chrome-extension/) + +By following these steps, you can efficiently use the local agent to test your APIs and generate test suites automatically. + +## Related -By following these steps, you can efficiently use the local agent to test your APIs and generate test suites automatically. \ No newline at end of file +- [API Test Recorder (Chrome Extension)](/docs/running-keploy/api-testing-chrome-extension/) — browser-based capture alternative. +- [Adding New Test Suites](/docs/running-keploy/api-testing-add-suite/) — create suites for local endpoints. +- [Authentication Setup for API Testing](/docs/running-keploy/api-testing-auth-setup/) — authenticate local endpoints. +- [API Test Generator](/docs/running-keploy/api-test-generator/) — generate tests for local APIs. diff --git a/versioned_docs/version-4.0.0/running-keploy/api-testing-mark-unbuggy.md b/versioned_docs/version-4.0.0/running-keploy/api-testing-mark-unbuggy.md index b15975303..5850bbaf3 100644 --- a/versioned_docs/version-4.0.0/running-keploy/api-testing-mark-unbuggy.md +++ b/versioned_docs/version-4.0.0/running-keploy/api-testing-mark-unbuggy.md @@ -45,7 +45,7 @@ Once you're on the test suite page: ### Immediate Changes -- **Status Update**: The suite status changes from "Buggy" to "Active" +- **Status Update**: The suite status changes from "Buggy" to "Active" - **Future Runs**: The suite will run normally in subsequent test executions - **Reporting**: The suite will be included in standard test reports - **Monitoring**: Keploy will continue monitoring the suite for new issues @@ -56,6 +56,7 @@ Once you're on the test suite page: **Scenario**: A 404 error was resolved by fixing the API endpoint **Before marking unbuggy**: + ```bash # Verify the endpoint is working curl -X POST https://api.example.com/owners \ @@ -68,10 +69,18 @@ curl -X POST https://api.example.com/owners \ **Scenario**: Response schema validation was fixed by updating the API **Verification steps**: + 1. Check that response format matches expectations 2. Verify all required fields are present 3. Confirm data types are correct This ensures that suites are automatically marked as unbuggy when automated fixes resolve issues. -Remember: Marking a suite as unbuggy should only be done after thoroughly verifying that all issues have been resolved and the suite is functioning correctly. \ No newline at end of file +Remember: Marking a suite as unbuggy should only be done after thoroughly verifying that all issues have been resolved and the suite is functioning correctly. + +## Related + +- [Buggy Test Suites](/docs/running-keploy/api-testing-buggy-suites/) — identify failing suites. +- [Fix with AI](/docs/running-keploy/api-testing-fix-with-ai/) — auto-repair failing suites. +- [Test Run Reports](/docs/running-keploy/api-testing-run-report/) — verify fixes in run reports. +- [Edit Test Suites](/docs/running-keploy/api-testing-edit-suites/) — manually fix suite issues. diff --git a/versioned_docs/version-4.0.0/running-keploy/api-testing-run-report.md b/versioned_docs/version-4.0.0/running-keploy/api-testing-run-report.md index 721074be6..c5305ed9f 100644 --- a/versioned_docs/version-4.0.0/running-keploy/api-testing-run-report.md +++ b/versioned_docs/version-4.0.0/running-keploy/api-testing-run-report.md @@ -10,11 +10,12 @@ tags: - test-results - test-management --- + import ProductTier from '@site/src/components/ProductTier'; -This guide explains how to use the run report page to track and analyze your test execution results. +This guide explains how to use the run report page to track and analyze your test execution results. ## Run Report List View @@ -60,23 +61,26 @@ Click on any report from the list to view detailed execution results: ### Understanding Test Results #### Passed Tests ✅ + - Tests that successfully completed all assertions - All validations matched expected results - No errors or warnings during execution #### Failed Tests ❌ + - Tests that did not meet assertion criteria - **Failure Reasons Displayed**: - Assertion mismatches - Unexpected response values - Status code mismatches - Timeout errors -- **Association Failures**: +- **Association Failures**: - Failures from dependent services or associations - External API failures affecting the test - Database connection issues -#### Buggy Tests +#### Buggy Tests + - Tests with identified bugs or inconsistent behavior - **Buggy Reasons Displayed**: - Shown on top of the particular test step @@ -91,14 +95,18 @@ The run report page provides powerful filtering options to help you analyze spec ### Available Filters #### 1. Filter by Suite Status + Filter tests based on their execution outcome: + - **Passed**: Show only successful tests - **Failed**: Show only failed tests - **Buggy**: Show only buggy tests - **All**: View all test results #### 2. Filter by Status Code + Filter by HTTP response status codes: + - **2xx Success**: 200 OK, 201 Created, 204 No Content - **3xx Redirection**: 301, 302, 304 - **4xx Client Errors**: 400, 401, 403, 404 @@ -106,7 +114,9 @@ Filter by HTTP response status codes: - **Custom Code**: Filter by specific status codes #### 3. Filter by HTTP Method + Filter tests by request method: + - **GET**: Retrieve operations - **POST**: Create operations - **PUT**: Update operations @@ -115,7 +125,9 @@ Filter tests by request method: - **OPTIONS, HEAD**: Other HTTP methods #### 4. Filter by Endpoint + Filter by API endpoint or URL path: + - Full endpoint URL - Partial path matching - Wildcard patterns @@ -128,7 +140,6 @@ Filter by API endpoint or URL path: - Select desired filter criteria - You can also apply multiple filters simultaneously - ## Detailed Test Step Information ### Viewing Step-by-Step Results @@ -203,4 +214,11 @@ For each test case, you can see: - **Team Collaboration**: Share results and insights with team - **Data-Driven Decisions**: Use metrics to improve test quality -By leveraging the run report features, you can maintain high-quality APIs, quickly identify and fix issues, and ensure comprehensive test coverage across your application. \ No newline at end of file +By leveraging the run report features, you can maintain high-quality APIs, quickly identify and fix issues, and ensure comprehensive test coverage across your application. + +## Related + +- [Sharing Reports](/docs/running-keploy/api-testing-sharing-reports/) — share reports with your team. +- [Running Selective Test Suites](/docs/running-keploy/api-testing-running-selective/) — run selected suites. +- [API Test Setup for GitHub CI/CD](/docs/running-keploy/api-testing-cicd/) — run reports in CI/CD. +- [Buggy Test Suites](/docs/running-keploy/api-testing-buggy-suites/) — investigate failing suites. diff --git a/versioned_docs/version-4.0.0/running-keploy/api-testing-schema-coverage.md b/versioned_docs/version-4.0.0/running-keploy/api-testing-schema-coverage.md index e60b7f2fc..91d54b0fa 100644 --- a/versioned_docs/version-4.0.0/running-keploy/api-testing-schema-coverage.md +++ b/versioned_docs/version-4.0.0/running-keploy/api-testing-schema-coverage.md @@ -35,6 +35,7 @@ The schema coverage page provides a comprehensive view of how well your test sui ### 1. Original Schema View The original schema section displays: + - **Your API Schema**: The original OpenAPI/Swagger schema or manually defined schema - **Schema Structure**: Complete API specification including: - Endpoints and paths @@ -46,6 +47,7 @@ The original schema section displays: ### 2. Total Coverage Metrics View comprehensive coverage statistics: + - **Overall Coverage Percentage**: Total schema coverage across all endpoints - **Endpoint Coverage**: Coverage breakdown by API endpoint - **Covered Lines**: Number of schema lines with test coverage @@ -54,6 +56,7 @@ View comprehensive coverage statistics: ### 3. Keploy Generated Schema The generated schema section shows: + - **Auto-Generated Schema**: Schema derived from recorded API calls - **Coverage Highlights**: Visual indication of covered vs uncovered parts - **Field-Level Coverage**: Which fields have been tested @@ -62,6 +65,7 @@ The generated schema section shows: ### Side-by-Side Comparison View original and generated schemas side by side: + ``` ┌──────────────────────────────────────────────────────────────────┐ │ Schema Coverage Analysis │ @@ -87,7 +91,7 @@ View original and generated schemas side by side: │ │ address: ❌ Not Covered │ address: ❌ Missing │ │ │ │ role: ⚠️ Partial │ role: ⚠️ Limited values │ │ │ │ │ │ │ -│ └─────────────────────────────┴──────────────────────────────┘ │ +│ └─────────────────────────────┴──────────────────────────────┘ │ │ │ │ [Cover Missing Lines] │ │ │ @@ -108,7 +112,6 @@ View original and generated schemas side by side: - **Status Codes**: Target specific response codes to test - **Data Variations**: Specify value ranges or combinations - ## Coverage Visualization - **Heat Map View**: Visual representation of coverage density @@ -121,6 +124,7 @@ View original and generated schemas side by side: ### Detailed Coverage Metrics #### Endpoint-Level Coverage + ``` /api/v1/users ├─ GET ✅ 100% (All fields covered) @@ -138,9 +142,17 @@ View original and generated schemas side by side: ### Coverage Gaps Identification Keploy automatically identifies: + 1. **Untested Endpoints**: API paths with no test coverage 2. **Missing HTTP Methods**: CRUD operations not tested 3. **Uncovered Fields**: Schema fields never validated 4. **Missing Edge Cases**: Boundary conditions not tested -By leveraging schema coverage analysis and automated test generation, you can ensure comprehensive API testing, maintain high code quality. \ No newline at end of file +By leveraging schema coverage analysis and automated test generation, you can ensure comprehensive API testing, maintain high code quality. + +## Related + +- [Test Generation History](/docs/running-keploy/api-testing-generation-history/) — track generation jobs. +- [API Test Generator](/docs/running-keploy/api-test-generator/) — how test generation works. +- [Bulk Assertions and Schema Validation](/docs/running-keploy/api-testing-bulk-assertions/) — validate schema in bulk. +- [Functions & Schema Assertions](/docs/running-keploy/api-testing-functions/) — schema and function assertions. diff --git a/versioned_docs/version-4.0.0/running-keploy/api-testing-sharing-reports.md b/versioned_docs/version-4.0.0/running-keploy/api-testing-sharing-reports.md index 63e4b0cad..25bacfa9d 100644 --- a/versioned_docs/version-4.0.0/running-keploy/api-testing-sharing-reports.md +++ b/versioned_docs/version-4.0.0/running-keploy/api-testing-sharing-reports.md @@ -53,6 +53,7 @@ Once added, they become a workspace member and can access shared reports based o When you share a report, the recipient can view: ### Execution Summary + - Total test cases executed - Passed / Failed count - Execution duration @@ -65,3 +66,9 @@ When you share a report, the recipient can view: - Add relevant team members directly from the dashboard - Maintain proper role-based access control +## Related + +- [Test Run Reports](/docs/running-keploy/api-testing-run-report/) — view detailed run reports. +- [Test Suite Settings & Actions](/docs/running-keploy/api-testing-suite-settings/) — manage suite settings. +- [API Test Setup for GitHub CI/CD](/docs/running-keploy/api-testing-cicd/) — generate reports in CI/CD. +- [Running Selective Test Suites](/docs/running-keploy/api-testing-running-selective/) — run suites to report on. diff --git a/versioned_docs/version-4.0.0/running-keploy/api-testing-tool-ai-powered.md b/versioned_docs/version-4.0.0/running-keploy/api-testing-tool-ai-powered.md index b88f9868c..f60427144 100644 --- a/versioned_docs/version-4.0.0/running-keploy/api-testing-tool-ai-powered.md +++ b/versioned_docs/version-4.0.0/running-keploy/api-testing-tool-ai-powered.md @@ -109,3 +109,10 @@ Keploy is built with security-first principles and is compliant with major indus Keploy Record Test case Your data and test traffic are handled securely, with the option to run Keploy entirely within your network using our self-hosted agent or BYOLLM infrastructure. To Learn more on our [security page](https://trust.keploy.io). + +## Related + +- [Generate API Tests using AI](/docs/running-keploy/generate-api-tests-using-ai/) — generate API tests with AI. +- [API Test Architecture](/docs/running-keploy/api-test-architecture/) — architecture behind generation. +- [Agent-Based API Test Generation](/docs/running-keploy/agent-test-generation/) — agent-based test generation. +- [Adding New Test Suites](/docs/running-keploy/api-testing-add-suite/) — add suites to your tests. diff --git a/versioned_docs/version-4.0.0/running-keploy/api-testing-variables.md b/versioned_docs/version-4.0.0/running-keploy/api-testing-variables.md index 59643bff7..352c1d653 100644 --- a/versioned_docs/version-4.0.0/running-keploy/api-testing-variables.md +++ b/versioned_docs/version-4.0.0/running-keploy/api-testing-variables.md @@ -44,3 +44,10 @@ Global variables serve as the centralized source of truth for your testing envir Configuring global variables in Keploy API testing **Example Context:** The **Global Variables** dashboard allows you to manage workspace-wide data. This includes static entries like the **base URL** and dynamic **Global Custom Functions**. For instance, `generateCompanyId()` is a function that returns a unique string starting with `COMP_` followed by a timestamp, ensuring unique identifiers for every test run. + +## Related + +- [Functions & Schema Assertions](/docs/running-keploy/api-testing-functions/) — pair variables with custom functions. +- [Custom Assertions](/docs/running-keploy/api-testing-custom-assertions/) — assert against captured variable values. +- [Editing Test Suites and Custom Assertions](/docs/running-keploy/api-testing-edit-assertions/) — where variables are configured. +- [Authentication Setup for API Testing](/docs/running-keploy/api-testing-auth-setup/) — inject tokens as global variables. diff --git a/versioned_docs/version-4.0.0/running-keploy/api-testing-webhook.md b/versioned_docs/version-4.0.0/running-keploy/api-testing-webhook.md index 72dfa54d9..a9f77e3e6 100644 --- a/versioned_docs/version-4.0.0/running-keploy/api-testing-webhook.md +++ b/versioned_docs/version-4.0.0/running-keploy/api-testing-webhook.md @@ -402,3 +402,10 @@ if *review.Request.StepPassed { // Only check steps that initially passed - **Respond Quickly:** Keploy will wait for your webhook's response. A slow webhook will slow down your entire test run. Aim for response times under 500ms. - **Log Everything:** Your webhook server should log every incoming request and the response it sends. This is invaluable for debugging. - **Handle Errors Gracefully:** If your server is down or returns a non-200 status code, Keploy will treat it as a transport failure and **fail the test step**. Ensure your server is robust. + +## Related + +- [Custom Assertions](/docs/running-keploy/api-testing-custom-assertions/) — add validation logic within Keploy itself. +- [Functions & Schema Assertions](/docs/running-keploy/api-testing-functions/) — programmatic checks on responses. +- [Public REST API](/docs/running-keploy/public-api/) — trigger runs programmatically from external systems. +- [Test Run Reports](/docs/running-keploy/api-testing-run-report/) — see webhook pass/fail reasons in results. diff --git a/versioned_docs/version-4.0.0/running-keploy/best-practices-api-testing.md b/versioned_docs/version-4.0.0/running-keploy/best-practices-api-testing.md index b42e910e2..189170751 100644 --- a/versioned_docs/version-4.0.0/running-keploy/best-practices-api-testing.md +++ b/versioned_docs/version-4.0.0/running-keploy/best-practices-api-testing.md @@ -82,3 +82,10 @@ keywords: - Output test name, request payload, status code, and failure reason. - Use structured reports for better traceability in CI/CD tools. + +## Related + +- [What is API testing?](/docs/running-keploy/about-api-testing/) — foundational concepts behind these practices. +- [API Test Setup for GitHub CI/CD](/docs/running-keploy/api-testing-cicd/) — automate regression tests in pipelines. +- [Variables in API Testing](/docs/running-keploy/api-testing-variables/) — chain requests for workflow validation. +- [Bulk Assertions and Schema Validation](/docs/running-keploy/api-testing-bulk-assertions/) — validate response structure and schema. diff --git a/versioned_docs/version-4.0.0/running-keploy/cli-commands.md b/versioned_docs/version-4.0.0/running-keploy/cli-commands.md index cf80e4bf2..b579ed7bc 100755 --- a/versioned_docs/version-4.0.0/running-keploy/cli-commands.md +++ b/versioned_docs/version-4.0.0/running-keploy/cli-commands.md @@ -463,3 +463,10 @@ keploy example [flags] Available Flags: - `--customSetup` - Displays commands tailored for custom user-defined setups. + +## Related + +- [Configuration File](/docs/running-keploy/configuration-file/) — set these flags once in `keploy.yaml`. +- [Recording Filters](/docs/running-keploy/recording-filters/) — control which requests get recorded. +- [Keploy Templatize](/docs/running-keploy/keploy-templatize/) — details on the `templatize` command. +- [Keploy Passthrough](/docs/running-keploy/keploy-passthrough/) — using the `--passThroughPorts` flag. diff --git a/versioned_docs/version-4.0.0/running-keploy/configuration-file.md b/versioned_docs/version-4.0.0/running-keploy/configuration-file.md index ab20dfcc6..0196e1778 100644 --- a/versioned_docs/version-4.0.0/running-keploy/configuration-file.md +++ b/versioned_docs/version-4.0.0/running-keploy/configuration-file.md @@ -488,3 +488,10 @@ Congratulations! You've now explored the features and configuration options prov Now armed with Keploy-config, you are ready to embark on a more organized and productive journey of recording and testing APIs with Keploy. Feel free to explore additional features, customize configurations, and refer to the [CLI Command Docs](https://keploy.io/docs/running-keploy/cli-commands/) for more details on available flags and parameters. Happy testing and may your APIs always return the expected results! 🚀 + +## Related + +- [Keploy CLI Commands](/docs/running-keploy/cli-commands/) — flags that map to config fields. +- [Recording Filters](/docs/running-keploy/recording-filters/) — filter traffic during recording. +- [Keploy Passthrough](/docs/running-keploy/keploy-passthrough/) — bypass rules and pass-through ports. +- [Adding a custom Mock to the Keploy Mock File](/docs/running-keploy/custom-mocks/) — work with recorded mocks. diff --git a/versioned_docs/version-4.0.0/running-keploy/custom-mocks.md b/versioned_docs/version-4.0.0/running-keploy/custom-mocks.md index 5b39c625c..81f02ba42 100644 --- a/versioned_docs/version-4.0.0/running-keploy/custom-mocks.md +++ b/versioned_docs/version-4.0.0/running-keploy/custom-mocks.md @@ -124,3 +124,10 @@ spec: timestamp: 2024-02-19T13:14:28.145240844Z --- ``` + +## Related + +- [Configuration File](/docs/running-keploy/configuration-file/) — configure mock paths and bypass rules. +- [Keploy Passthrough](/docs/running-keploy/keploy-passthrough/) — skip mocking for specific ports. +- [Keploy CLI Commands](/docs/running-keploy/cli-commands/) — record commands that generate mock files. +- [Keploy Templatize](/docs/running-keploy/keploy-templatize/) — templatize dynamic values in mocks. diff --git a/versioned_docs/version-4.0.0/running-keploy/docker-tls.md b/versioned_docs/version-4.0.0/running-keploy/docker-tls.md index 3132303a3..deb10e3cc 100644 --- a/versioned_docs/version-4.0.0/running-keploy/docker-tls.md +++ b/versioned_docs/version-4.0.0/running-keploy/docker-tls.md @@ -65,3 +65,10 @@ keploy test -c "Docker_CMD_to_run_user_container --network " --con Voilà! 🧑🏻‍💻 We have the tests with data mocks running! 🐰🎉 You'll be able to see the test cases that ran with the results report on the console as well as locally in the `testReport` directory. + +## Related + +- [Keploy CLI Commands](/docs/running-keploy/cli-commands/) — full record and test flag reference. +- [Configuration File](/docs/running-keploy/configuration-file/) — set container and network names in `keploy.yaml`. +- [Keploy Passthrough](/docs/running-keploy/keploy-passthrough/) — pass through ports for containerized dependencies. +- [Adding a custom Mock to the Keploy Mock File](/docs/running-keploy/custom-mocks/) — mock services you cannot containerize. diff --git a/versioned_docs/version-4.0.0/running-keploy/generate-api-tests-using-ai.md b/versioned_docs/version-4.0.0/running-keploy/generate-api-tests-using-ai.md index 9ed8022b7..fc18477d0 100644 --- a/versioned_docs/version-4.0.0/running-keploy/generate-api-tests-using-ai.md +++ b/versioned_docs/version-4.0.0/running-keploy/generate-api-tests-using-ai.md @@ -78,3 +78,10 @@ Every test generated will include: [//]: # "- 🧹 [Review, clean, and improve test flows](/docs/running-keploy/review-and-improve-ai-generated-tests)" [//]: # "- 🤝 [Share tests and test-reports with your team](/docs/running-keploy/share-tests)" [//]: # "- 🚀 [Integrate tests in your CI/CD pipeline](/docs/running-keploy/ci-cd-ai-gen-api-tests)" + +## Related + +- [API Test Recorder (Chrome Extension)](/docs/running-keploy/api-testing-chrome-extension/) — capture flows via the browser instead. +- [Run AI-Generated API Tests](/docs/running-keploy/run-ai-generated-api-tests/) — execute the tests you just generated. +- [Review & Improve AI-Generated API Tests](/docs/running-keploy/review-and-improve-ai-generated-tests/) — refine and harden generated suites. +- [Using Keploy Local Agent](/docs/running-keploy/api-testing-local-agent/) — proxy private endpoints for generation. diff --git a/versioned_docs/version-4.0.0/running-keploy/k8s-proxy-daemonset-architecture.md b/versioned_docs/version-4.0.0/running-keploy/k8s-proxy-daemonset-architecture.md index 9e9162468..c003ebfa9 100644 --- a/versioned_docs/version-4.0.0/running-keploy/k8s-proxy-daemonset-architecture.md +++ b/versioned_docs/version-4.0.0/running-keploy/k8s-proxy-daemonset-architecture.md @@ -254,3 +254,9 @@ Recording mode and replay environment are orthogonal—every combination is vali | Production with read-only RBAC on the source namespace, no spare K8s cluster but a Docker host | DaemonSet | `runner` | For the operational walkthrough of the cluster-mode setup, see the K8s Proxy REST API guide's setup section. + +## Related + +- [Kubernetes Proxy REST API](/docs/running-keploy/k8s-proxy-api/) — drive recording and replay via REST. +- [Recording Filters](/docs/running-keploy/recording-filters/) — scope which requests get captured. +- [Public REST API](/docs/running-keploy/public-api/) — Keploy Cloud control-plane API. diff --git a/versioned_docs/version-4.0.0/running-keploy/keploy-karaf.md b/versioned_docs/version-4.0.0/running-keploy/keploy-karaf.md index 168286ca3..a41a75e2d 100644 --- a/versioned_docs/version-4.0.0/running-keploy/keploy-karaf.md +++ b/versioned_docs/version-4.0.0/running-keploy/keploy-karaf.md @@ -115,3 +115,10 @@ Replace the placeholder values with actual paths and keys as needed. This assumes your Karaf application is running locally on port 8181. After running the tests, a `coverage.xml` file will be generated in the root directory of your project. This file contains the test coverage report, which can be used for further analysis or integrated with CI/CD pipelines. + +## Related + +- [Keploy CLI Commands](/docs/running-keploy/cli-commands/) — record and test command reference. +- [Configuration File](/docs/running-keploy/configuration-file/) — persist settings in `keploy.yaml`. +- [TLS Docker Support](/docs/running-keploy/docker-tls/) — run Keploy against containerized apps. +- [Keploy Passthrough](/docs/running-keploy/keploy-passthrough/) — pass through dependency ports. diff --git a/versioned_docs/version-4.0.0/running-keploy/keploy-passthrough.md b/versioned_docs/version-4.0.0/running-keploy/keploy-passthrough.md index 9070ed554..1f9c439ce 100644 --- a/versioned_docs/version-4.0.0/running-keploy/keploy-passthrough.md +++ b/versioned_docs/version-4.0.0/running-keploy/keploy-passthrough.md @@ -31,3 +31,9 @@ sudo -E env 'PATH=$PATH' main.go record -c "java -jar path/to/user/jar" --passTh ```zsh sudo -E env 'PATH=$PATH' main.go test -c "java -jar path/to/user/jar" --delay 25 --passThroughPorts 5672,5432 ``` + +## Related + +- [Recording Filters](/docs/running-keploy/recording-filters/) — control which calls Keploy captures. +- [Adding a custom Mock](/docs/running-keploy/custom-mocks/) — hand-author mocks for dependencies. +- [Keploy CLI Commands](/docs/running-keploy/cli-commands/) — full command and flag reference. diff --git a/versioned_docs/version-4.0.0/running-keploy/keploy-templatize.md b/versioned_docs/version-4.0.0/running-keploy/keploy-templatize.md index 034a52a22..be6e8cafc 100644 --- a/versioned_docs/version-4.0.0/running-keploy/keploy-templatize.md +++ b/versioned_docs/version-4.0.0/running-keploy/keploy-templatize.md @@ -39,3 +39,9 @@ sudo -E env 'PATH=$PATH' keploy templatize -t="test-set-1" > **Note** > > Even though you can use templatize multiple times, even on testsets that have already been templatized, but it is not reversible. So make sure you create a copy of your keploy folder before trying it out. + +## Related + +- [Adding a custom Mock](/docs/running-keploy/custom-mocks/) — pair templates with custom mocks. +- [Configuration File](/docs/running-keploy/configuration-file/) — set defaults for record and test. +- [Recording Filters](/docs/running-keploy/recording-filters/) — narrow what gets recorded. diff --git a/versioned_docs/version-4.0.0/running-keploy/recording-filters.md b/versioned_docs/version-4.0.0/running-keploy/recording-filters.md index e33f679d0..01f6982c2 100644 --- a/versioned_docs/version-4.0.0/running-keploy/recording-filters.md +++ b/versioned_docs/version-4.0.0/running-keploy/recording-filters.md @@ -16,7 +16,6 @@ import ProductTier from '@site/src/components/ProductTier'; - Keploy lets you configure **filters when starting a recording on any deployment**. Filters give you precise control over which requests get captured. You can limit recording to specific paths, methods, hosts, or headers, or explicitly exclude traffic you do not need. Filters are **optional**. If none are configured, Keploy records **all traffic** on the selected pods. @@ -26,9 +25,8 @@ Filters are **optional**. If none are configured, Keploy records **all traffic** Filters are configured in **Step 2 (Record config)** of the **Start Recording** flow. -![Where to configure filters](https://keploy-devrel.s3.us-west-2.amazonaws.com/landing/where-to-configure.png) - +![Where to configure filters](https://keploy-devrel.s3.us-west-2.amazonaws.com/landing/where-to-configure.png) To get there: @@ -41,8 +39,8 @@ To get there: Each filter runs in one of two modes: -* Exclude: Requests that match this filter **will be dropped and not recorded**. -* Include: Only requests that match this filter **will be recorded**. Everything else is ignored. +- Exclude: Requests that match this filter **will be dropped and not recorded**. +- Include: Only requests that match this filter **will be recorded**. Everything else is ignored. > **Note:** > Use **Exclude** when you want to record most traffic but remove noise like health checks, probes, or irrelevant endpoints. @@ -52,25 +50,25 @@ Each filter runs in one of two modes: Each filter supports the following fields. You can fill **one or more**. Only the fields you populate are evaluated. -* **Path (Regex)** -Matches the request path using a regular expression. -Example: `/api/v1/.*` This captures all paths under `/api/v1/`. +- **Path (Regex)** + Matches the request path using a regular expression. + Example: `/api/v1/.*` This captures all paths under `/api/v1/`. -* **Host** -Matches the target host. -Example: `api.internal` +- **Host** + Matches the target host. + Example: `api.internal` -* **Port** -Matches the port number. -Example: `8080` +- **Port** + Matches the port number. + Example: `8080` -* **Methods** -Comma-separated list of HTTP methods. -Example: `GET`, `POST` +- **Methods** + Comma-separated list of HTTP methods. + Example: `GET`, `POST` -* **Headers** -Matches a specific request header. Enter the header key and a regex as the value. -Example: key = `x-record`, value = `true`. +- **Headers** + Matches a specific request header. Enter the header key and a regex as the value. + Example: key = `x-record`, value = `true`. You can add multiple header conditions using **+ Add Header**. @@ -88,18 +86,16 @@ For example, if you set Path to `/api/v1/.*` and Methods to `GET`, `POST`, only This filter captures only requests where a specific header value matches a regular expression pattern. The filter is set to Include mode, meaning all other traffic is ignored. - - + ![Include filter with regex header](https://keploy-devrel.s3.us-west-2.amazonaws.com/landing/start-recording.png) ## Example: Include Filter with Exact Header This example shows an `Include` filter matching on a header key with the exact value `true`. This is the simplest form of header-based filtering. Only requests carrying that header with that value will be recorded. - - + ![Include filter with exact header](https://keploy-devrel.s3.us-west-2.amazonaws.com/landing/start-recording-1.png) ## Client TLS Private Key @@ -111,3 +107,9 @@ If your services do not use mTLS, leave this section empty and proceed. ## After Filters Are Applied Once you click Next, Keploy proceeds to Step 3 (Auto replay config) to complete the recording setup. After a recording starts, there is no in-UI view of which specific requests are being captured. Keploy applies your filters in the background and records all matching traffic into test cases automatically. + +## Related + +- [Adding a custom Mock](/docs/running-keploy/custom-mocks/) — supply mocks for filtered dependencies. +- [Keploy Passthrough](/docs/running-keploy/keploy-passthrough/) — let selected calls hit the real service. +- [Configuration File](/docs/running-keploy/configuration-file/) — persist filter settings. diff --git a/versioned_docs/version-4.0.0/running-keploy/rename-testcases.md b/versioned_docs/version-4.0.0/running-keploy/rename-testcases.md index 61aeb4752..af5711709 100644 --- a/versioned_docs/version-4.0.0/running-keploy/rename-testcases.md +++ b/versioned_docs/version-4.0.0/running-keploy/rename-testcases.md @@ -55,3 +55,9 @@ curl --request POST \ ## Rename Test-Sets To rename your test set, you can manually override the default name from `test-set-0` to a `kTest-0` in the `keploy` folder. + +## Related + +- [Keploy CLI Commands](/docs/running-keploy/cli-commands/) — commands that operate on test cases. +- [Configuration File](/docs/running-keploy/configuration-file/) — configure test-set behaviour. +- [Adding a custom Mock](/docs/running-keploy/custom-mocks/) — manage the files alongside test cases. diff --git a/versioned_docs/version-4.0.0/running-keploy/review-and-improve-ai-generated-tests.md b/versioned_docs/version-4.0.0/running-keploy/review-and-improve-ai-generated-tests.md index cfbc4f59f..2174b67a9 100644 --- a/versioned_docs/version-4.0.0/running-keploy/review-and-improve-ai-generated-tests.md +++ b/versioned_docs/version-4.0.0/running-keploy/review-and-improve-ai-generated-tests.md @@ -90,3 +90,9 @@ In the Test Suites list, hover over any row to reveal the ︙ (more-options) men All changes are saved instantly and logged. ⚠️ Deletion is irreversible. Use Git history or backups to restore. + +## Related + +- [Run AI-Generated API Tests](/docs/running-keploy/run-ai-generated-api-tests/) — execute the generated suites. +- [Self-Healing API Tests](/docs/running-keploy/self-healing-ai-api-tests/) — auto-repair tests as APIs change. +- [Generate API Tests using AI](/docs/running-keploy/generate-api-tests-using-ai/) — how the tests are produced. diff --git a/versioned_docs/version-4.0.0/running-keploy/risk-profile-analysis.md b/versioned_docs/version-4.0.0/running-keploy/risk-profile-analysis.md index c5d9cab61..f608ea3c4 100644 --- a/versioned_docs/version-4.0.0/running-keploy/risk-profile-analysis.md +++ b/versioned_docs/version-4.0.0/running-keploy/risk-profile-analysis.md @@ -87,3 +87,9 @@ tests: category: - SCHEMA_ADDED ``` + +## Related + +- [Review & Improve AI-Generated API Tests](/docs/running-keploy/review-and-improve-ai-generated-tests/) — act on risk findings. +- [Run AI-Generated API Tests](/docs/running-keploy/run-ai-generated-api-tests/) — run suites the analysis scores. +- [Generate API Tests using AI](/docs/running-keploy/generate-api-tests-using-ai/) — the generation step upstream. diff --git a/versioned_docs/version-4.0.0/running-keploy/run-ai-generated-api-tests.md b/versioned_docs/version-4.0.0/running-keploy/run-ai-generated-api-tests.md index fd531bb0b..cbb256b62 100644 --- a/versioned_docs/version-4.0.0/running-keploy/run-ai-generated-api-tests.md +++ b/versioned_docs/version-4.0.0/running-keploy/run-ai-generated-api-tests.md @@ -52,3 +52,9 @@ Iterate quickly: 3. Compare the new report with the previous one right in the dashboard to verify the fix. You now have a pipeline—from triggering the run to an all-green build—that safeguards your API contract in every environment. + +## Related + +- [Generate API Tests using AI](/docs/running-keploy/generate-api-tests-using-ai/) — create the tests first. +- [Review & Improve AI-Generated API Tests](/docs/running-keploy/review-and-improve-ai-generated-tests/) — refine the results. +- [Self-Healing API Tests](/docs/running-keploy/self-healing-ai-api-tests/) — keep tests passing as APIs evolve. diff --git a/versioned_docs/version-4.0.0/running-keploy/self-healing-ai-api-tests.md b/versioned_docs/version-4.0.0/running-keploy/self-healing-ai-api-tests.md index 8bc872c96..488ce0971 100644 --- a/versioned_docs/version-4.0.0/running-keploy/self-healing-ai-api-tests.md +++ b/versioned_docs/version-4.0.0/running-keploy/self-healing-ai-api-tests.md @@ -37,7 +37,7 @@ Keploy can automatically fix failing test cases using its built-in AI engine. Th 3. **Click "Fix with AI"** - - Keploy AI analyzes the diff between the expected and actual response. It then proposes updated assertions, allowing you to review and accept the 'healed' version as + - Keploy AI analyzes the diff between the expected and actual response. It then proposes updated assertions, allowing you to review and accept the 'healed' version as the new source of truth. 4. _(Optional)_ **Add Context** @@ -62,3 +62,9 @@ Keploy can automatically fix failing test cases using its built-in AI engine. Th - Combine healing with test deduplication to keep your suite clean. [//]: # "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)." + +## Related + +- [Run AI-Generated API Tests](/docs/running-keploy/run-ai-generated-api-tests/) — where self-healing applies. +- [Review & Improve AI-Generated API Tests](/docs/running-keploy/review-and-improve-ai-generated-tests/) — manual refinement. +- [Generate API Tests using AI](/docs/running-keploy/generate-api-tests-using-ai/) — the generation pipeline. diff --git a/versioned_docs/version-4.0.0/running-keploy/share-tests.md b/versioned_docs/version-4.0.0/running-keploy/share-tests.md index 7c295c527..5ef45e87a 100644 --- a/versioned_docs/version-4.0.0/running-keploy/share-tests.md +++ b/versioned_docs/version-4.0.0/running-keploy/share-tests.md @@ -30,3 +30,9 @@ Click **Share**. Keploy sends: with a direct link to the suite. New users must **accept the invite** to gain access. + +## Related + +- [Sharing Reports](/docs/running-keploy/api-testing-sharing-reports/) — share run results, not just suites. +- [Test Run Reports](/docs/running-keploy/api-testing-run-report/) — read the reports you share. +- [Keploy Test Run Reports](/docs/running-keploy/test-run-reports/) — report internals and history. diff --git a/versioned_docs/version-4.0.0/running-keploy/test-generate.md b/versioned_docs/version-4.0.0/running-keploy/test-generate.md index 78cbdb5a0..1f4b981b0 100644 --- a/versioned_docs/version-4.0.0/running-keploy/test-generate.md +++ b/versioned_docs/version-4.0.0/running-keploy/test-generate.md @@ -74,3 +74,9 @@ Enhance test accuracy by uploading documentation such as: - 🗂 **Feature briefs or requirement docs** These help Keploy better understand the intended logic and behavior of each endpoint. + +## Related + +- [Generate API Tests using AI](/docs/running-keploy/generate-api-tests-using-ai/) — the end-to-end generation guide. +- [Agent-Based API Test Generation](/docs/running-keploy/agent-test-generation/) — generate from a local agent. +- [Run AI-Generated API Tests](/docs/running-keploy/run-ai-generated-api-tests/) — run what you generate. diff --git a/versioned_docs/version-4.0.0/running-keploy/test-run-reports.md b/versioned_docs/version-4.0.0/running-keploy/test-run-reports.md index 61a134802..ba9bb1ee9 100644 --- a/versioned_docs/version-4.0.0/running-keploy/test-run-reports.md +++ b/versioned_docs/version-4.0.0/running-keploy/test-run-reports.md @@ -116,3 +116,9 @@ Update the request configuration for each test case: - ✅ **Save Changes** — Apply edits to the test step and update the suite. - ❌ **Cancel** — Discard any unsaved modifications and revert to the last saved state. + +## Related + +- [Test Run Reports](/docs/running-keploy/api-testing-run-report/) — the per-run report view. +- [Sharing Reports](/docs/running-keploy/api-testing-sharing-reports/) — share reports with your team. +- [Share Test Suite With Your Team](/docs/running-keploy/share-tests/) — share the suites themselves. diff --git a/versioned_docs/version-4.0.0/running-keploy/unit-test-architecture.md b/versioned_docs/version-4.0.0/running-keploy/unit-test-architecture.md index 2e0d95b5f..7386e7c64 100644 --- a/versioned_docs/version-4.0.0/running-keploy/unit-test-architecture.md +++ b/versioned_docs/version-4.0.0/running-keploy/unit-test-architecture.md @@ -36,3 +36,9 @@ Here’s how Keploy leverages AI (LLM) to automate and streamline the unit testi ## In Short Keploy’s AI-driven architecture turns CI feedback and your codebase into a robust, scalable set of unit tests—saving you hours and catching regressions before they hit production. + +## Related + +- [Keploy Unit Test Generator](/docs/running-keploy/unit-test-generator/) — the generator built on this architecture. +- [What is Unit Testing?](/docs/running-keploy/about-unit-testing/) — unit testing fundamentals. +- [API Test Architecture](/docs/running-keploy/api-test-architecture/) — the API-side counterpart. diff --git a/versioned_docs/version-4.0.0/running-keploy/unit-test-generator.md b/versioned_docs/version-4.0.0/running-keploy/unit-test-generator.md index 7c30cae01..97558d591 100644 --- a/versioned_docs/version-4.0.0/running-keploy/unit-test-generator.md +++ b/versioned_docs/version-4.0.0/running-keploy/unit-test-generator.md @@ -34,3 +34,9 @@ Keploy's UTG aims to: 1. **PR Agent**: Install a GitHub App on your repo to automatically generate tests when you create a pull request. 2. **VS Code Extension**: Generate test files with a single click directly from your IDE. + +## Related + +- [Unit Test Architecture](/docs/running-keploy/unit-test-architecture/) — how the generator is structured. +- [Keploy's PR Agent](/docs/running-keploy/utg-pr-agent/) — generate unit tests on pull requests. +- [Keploy's VS Code Extension](/docs/running-keploy/utg-vscode-extension/) — generate unit tests in your editor. diff --git a/versioned_docs/version-4.0.0/running-keploy/utg-pr-agent.md b/versioned_docs/version-4.0.0/running-keploy/utg-pr-agent.md index beff70a8e..906c2740c 100644 --- a/versioned_docs/version-4.0.0/running-keploy/utg-pr-agent.md +++ b/versioned_docs/version-4.0.0/running-keploy/utg-pr-agent.md @@ -89,3 +89,9 @@ Ready to transform your pull request workflow from a potential quality bottlenec 3. **Experience the difference** in your next code review cycle _Elevate your development workflow. Make every pull request a quality checkpoint._ + +## Related + +- [Keploy Unit Test Generator](/docs/running-keploy/unit-test-generator/) — the engine behind the PR agent. +- [Keploy's VS Code Extension](/docs/running-keploy/utg-vscode-extension/) — the same generator in your IDE. +- [Unit Test Architecture](/docs/running-keploy/unit-test-architecture/) — how generated unit tests are built. diff --git a/versioned_docs/version-4.0.0/running-keploy/utg-vsc-extension.md b/versioned_docs/version-4.0.0/running-keploy/utg-vsc-extension.md index deffc6f11..d388e7020 100644 --- a/versioned_docs/version-4.0.0/running-keploy/utg-vsc-extension.md +++ b/versioned_docs/version-4.0.0/running-keploy/utg-vsc-extension.md @@ -125,3 +125,9 @@ Don't let testing slow down your development velocity. With Keploy's AI-powered 4. **Watch your test coverage soar** while maintaining development speed \_Transform your IDE. Elevate your code quality. Join 500k+ developers building better software with Keploy. + +## Related + +- [Keploy's PR Agent](/docs/running-keploy/utg-pr-agent/) — the same generator on pull requests. +- [Keploy Unit Test Generator](/docs/running-keploy/unit-test-generator/) — the generator internals. +- [Unit Test Architecture](/docs/running-keploy/unit-test-architecture/) — how generated unit tests are built. From a292feff3c9f26f521476349523b0bba235b97cc Mon Sep 17 00:00:00 2001 From: dhananjay6561 Date: Mon, 10 Aug 2026 19:10:12 +0530 Subject: [PATCH 18/26] docs(A4): add "Related" cross-links to quickstart sample apps Add a "Related" section to quickstart sample-app guides, linking same-language / same-datastore samples and the language recommendation page. Routes verified against the build (slugs differ from filenames here). Signed-off-by: dhananjay6561 --- .../version-4.0.0/quickstart/code-coverage.md | 11 +- .../quickstart/csharp-dotnet-postgres.md | 7 + .../quickstart/express-postgresql-prisma.md | 7 + .../version-4.0.0/quickstart/flask-redis.md | 7 + .../quickstart/go-fasthttp-postgres.md | 7 + .../version-4.0.0/quickstart/go-gin-redis.md | 7 + .../version-4.0.0/quickstart/go-mux-mysql.md | 7 + .../version-4.0.0/quickstart/go-mux-sql.md | 7 + .../quickstart/golang-recommendation.md | 7 + .../java-quickstart-recommendation.md | 7 + .../quickstart/java-spring-boot-mongo.md | 7 + .../java-spring-boot-openhospital.md | 7 + .../quickstart/java-spring-boot-xml.md | 7 + .../quickstart/java-spring-postgres.md | 7 + .../quickstart/javascript-recommendation.md | 7 + .../k8s-proxy-developer-workflow.md | 6 + .../quickstart/k8s-proxy-llm-workflow.md | 6 + .../version-4.0.0/quickstart/k8s-proxy.md | 6 + .../quickstart/nextjs-postgres.md | 7 + .../quickstart/node-express-mongoose.md | 7 + .../version-4.0.0/quickstart/node-jwt-sql.md | 7 + .../quickstart/python-django-sql.md | 7 + .../quickstart/python-fastapi-sql.md | 7 + .../quickstart/python-fastapi-twilio.md | 7 + .../quickstart/python-flask-mongo.md | 7 + .../quickstart/python-microservices.md | 163 +++++++++--------- .../python-quickstart-recommendation.md | 7 + .../quickstart/rust-recommendation.md | 6 + .../quickstart/rust-wrap-mongo.md | 6 + .../version-4.0.0/quickstart/sample-apps.md | 6 + .../quickstart/sample-rust-crud-mongo.md | 6 + .../version-4.0.0/quickstart/sample-ts.md | 6 + .../version-4.0.0/quickstart/samples-bunjs.md | 6 + .../version-4.0.0/quickstart/samples-echo.md | 6 + .../quickstart/samples-express-mongoose.md | 6 + .../quickstart/samples-go-gin-mongo.md | 6 + .../quickstart/samples-go-sse-svelte.md | 6 + .../version-4.0.0/quickstart/samples-java.md | 6 + .../quickstart/samples-node-mongo.md | 6 + .../version-4.0.0/quickstart/samples-rust.md | 6 + .../version-4.0.0/quickstart/sanic-mongo.md | 6 + 41 files changed, 350 insertions(+), 80 deletions(-) diff --git a/versioned_docs/version-4.0.0/quickstart/code-coverage.md b/versioned_docs/version-4.0.0/quickstart/code-coverage.md index 24abcb386..c5945db53 100644 --- a/versioned_docs/version-4.0.0/quickstart/code-coverage.md +++ b/versioned_docs/version-4.0.0/quickstart/code-coverage.md @@ -32,8 +32,8 @@ High code coverage does not always mean good tests, but it ensures that critical - - ## ✅ Schema Coverage + +## ✅ Schema Coverage Schema coverage measures how much of your **API schema** (endpoints, request/response fields, contracts) is exercised during testing. @@ -70,3 +70,10 @@ Statement coverage measures how many **individual lines/statements of code** are + +## Related + +- [Sample Golang Apps](/docs/quickstart/golang-filter/) — Go samples to measure coverage. +- [Sample Java Apps](/docs/quickstart/java-springboot-filter/) — Java samples with coverage reports. +- [Sample Python Apps](/docs/quickstart/python-filter/) — Python samples to try coverage. +- [Keploy Integration with PetClinic App](/docs/quickstart/pet-clinic/) — Java app with Jacoco coverage. diff --git a/versioned_docs/version-4.0.0/quickstart/csharp-dotnet-postgres.md b/versioned_docs/version-4.0.0/quickstart/csharp-dotnet-postgres.md index 772a12efa..f84aa68b4 100644 --- a/versioned_docs/version-4.0.0/quickstart/csharp-dotnet-postgres.md +++ b/versioned_docs/version-4.0.0/quickstart/csharp-dotnet-postgres.md @@ -205,3 +205,10 @@ Final thoughts? Dive deeper! Try different API calls, tweak the DB response in t Congrats on the journey so far! You've seen Keploy's power, flexed your coding muscles, and had a bit of fun too! Now, go out there and keep exploring, innovating, and creating! Remember, with the right tools and a sprinkle of fun, anything's possible. 😊🚀 Happy coding! ✨👩‍💻👨‍💻✨ + +## Related + +- [Sample CRUD App (Golang)](/docs/quickstart/samples-fasthttp/) — another Postgres-backed CRUD app. +- [Sample Product Catalog App (Golang)](/docs/quickstart/samples-mux/) — Go app using Postgres. +- [Express + PostgreSQL + Prisma Sample Application](/docs/quickstart/express-postgresql-prisma/) — Postgres with an ORM. +- [NextJs Sample Application](/docs/quickstart/samples-nextjs/) — NextJS app on Postgres. diff --git a/versioned_docs/version-4.0.0/quickstart/express-postgresql-prisma.md b/versioned_docs/version-4.0.0/quickstart/express-postgresql-prisma.md index 13585a1b8..92c9a7890 100644 --- a/versioned_docs/version-4.0.0/quickstart/express-postgresql-prisma.md +++ b/versioned_docs/version-4.0.0/quickstart/express-postgresql-prisma.md @@ -440,3 +440,10 @@ Node.js v22.7.0 ``` Voila! 🎉 You have successfully tested the application using Keploy. Keploy also generates coverage reports for the test-suites. + +## Related + +- [Sample JavaScript Apps](/docs/quickstart/javascript-filter/) — browse more JS samples. +- [Node.js Express Mongoose Sample](/docs/quickstart/samples-nodejs/) — Express with a different datastore. +- [NodeJS - JWT Sample Application](/docs/quickstart/samples-node-jwt/) — Node app on Postgres. +- [NextJs Sample Application](/docs/quickstart/samples-nextjs/) — another Postgres-backed JS app. diff --git a/versioned_docs/version-4.0.0/quickstart/flask-redis.md b/versioned_docs/version-4.0.0/quickstart/flask-redis.md index c9277d6cd..8f4951bf5 100644 --- a/versioned_docs/version-4.0.0/quickstart/flask-redis.md +++ b/versioned_docs/version-4.0.0/quickstart/flask-redis.md @@ -172,3 +172,10 @@ You can also check the test summary from your cli ### Wrapping it up 🎉 Congrats on the journey so far! You've seen Keploy's power, flexed your coding muscles, and had a bit of fun too! Now, go out there and keep exploring, innovating, and creating! Remember, with the right tools and a sprinkle of fun, anything's possible. 😊🚀 + +## Related + +- [Sample Python Apps](/docs/quickstart/python-filter/) — browse more Python samples. +- [Sample User Authentication App (Golang)](/docs/quickstart/samples-redis/) — another Redis-backed app. +- [Sample Task Creation CRUD App](/docs/quickstart/samples-flask/) — another Flask sample. +- [Sample Student Data CRUD App](/docs/quickstart/samples-fastapi/) — Python CRUD API. diff --git a/versioned_docs/version-4.0.0/quickstart/go-fasthttp-postgres.md b/versioned_docs/version-4.0.0/quickstart/go-fasthttp-postgres.md index 706c3a809..c2f94998c 100644 --- a/versioned_docs/version-4.0.0/quickstart/go-fasthttp-postgres.md +++ b/versioned_docs/version-4.0.0/quickstart/go-fasthttp-postgres.md @@ -149,3 +149,10 @@ Final thoughts? Dive deeper! Try different API calls, tweak the DB response in t Congrats on the journey so far! You've seen Keploy's power, flexed your coding muscles, and had a bit of fun too! Now, go out there and keep exploring, innovating, and creating! Remember, with the right tools and a sprinkle of fun, anything's possible Happy coding! ✨👩‍💻👨‍💻✨ + +## Related + +- [Sample Golang Apps](/docs/quickstart/golang-filter/) — browse more Go samples. +- [Sample Product Catalog App (Golang)](/docs/quickstart/samples-mux/) — another Go Postgres app. +- [Mux MySQL Sample Application](/docs/quickstart/samples-mysql/) — Go with a SQL datastore. +- [Sample URL Shortener App (Golang)](/docs/quickstart/samples-gin/) — another Go sample. diff --git a/versioned_docs/version-4.0.0/quickstart/go-gin-redis.md b/versioned_docs/version-4.0.0/quickstart/go-gin-redis.md index c95f3cbbf..9433640d1 100644 --- a/versioned_docs/version-4.0.0/quickstart/go-gin-redis.md +++ b/versioned_docs/version-4.0.0/quickstart/go-gin-redis.md @@ -472,3 +472,10 @@ Final thoughts? Dive deeper! Try different API calls, tweak the DB response in t Congrats on the journey so far! You've seen Keploy's power, flexed your coding muscles, and had a bit of fun too! Now, go out there and keep exploring, innovating, and creating! Remember, with the right tools and a sprinkle of fun, anything's possible. 😊🚀 Hope this helps you out, if you still have any questions, reach out to us . + +## Related + +- [Sample Golang Apps](/docs/quickstart/golang-filter/) — browse more Go samples. +- [Sample Product Catalog App (Golang)](/docs/quickstart/samples-mux/) — another Go sample. +- [Sample URL Shortener App (Golang)](/docs/quickstart/samples-gin/) — another Gin-based Go app. +- [Sample Library App (Flask + Redis)](/docs/quickstart/flask-redis/) — another Redis-backed app. diff --git a/versioned_docs/version-4.0.0/quickstart/go-mux-mysql.md b/versioned_docs/version-4.0.0/quickstart/go-mux-mysql.md index d8816e42a..247418238 100644 --- a/versioned_docs/version-4.0.0/quickstart/go-mux-mysql.md +++ b/versioned_docs/version-4.0.0/quickstart/go-mux-mysql.md @@ -249,3 +249,10 @@ We will get output something like this: ### Wrapping it up 🎉 Congrats on the journey so far! You've seen Keploy's power, flexed your coding muscles, and had a bit of fun too! Now, go out there and keep exploring, innovating, and creating! Remember, with the right tools and a sprinkle of fun, anything's possible.😊🚀 + +## Related + +- [Sample Golang Apps](/docs/quickstart/golang-filter/) — browse more Go samples. +- [Sample Product Catalog App (Golang)](/docs/quickstart/samples-mux/) — Mux with Postgres. +- [Sample CRUD App (Golang)](/docs/quickstart/samples-fasthttp/) — another Go SQL app. +- [Echo SQL Sample Application](/docs/quickstart/samples-echo/) — another Go SQL sample. diff --git a/versioned_docs/version-4.0.0/quickstart/go-mux-sql.md b/versioned_docs/version-4.0.0/quickstart/go-mux-sql.md index c34976dc0..b5b4c0d83 100644 --- a/versioned_docs/version-4.0.0/quickstart/go-mux-sql.md +++ b/versioned_docs/version-4.0.0/quickstart/go-mux-sql.md @@ -439,3 +439,10 @@ Final thoughts? Dive deeper! Try different API calls, tweak the DB response in t Congrats on the journey so far! You've seen Keploy's power, flexed your coding muscles, and had a bit of fun too! Now, go out there and keep exploring, innovating, and creating! Remember, with the right tools and a sprinkle of fun, anything's possible. 😊🚀 Hope this helps you out, if you still have any questions, reach out to us . + +## Related + +- [Sample Golang Apps](/docs/quickstart/golang-filter/) — browse more Go samples. +- [Sample CRUD App (Golang)](/docs/quickstart/samples-fasthttp/) — another Go Postgres app. +- [Mux MySQL Sample Application](/docs/quickstart/samples-mysql/) — Mux with MySQL. +- [Sample URL Shortener App (Golang)](/docs/quickstart/samples-gin/) — another Go sample. diff --git a/versioned_docs/version-4.0.0/quickstart/golang-recommendation.md b/versioned_docs/version-4.0.0/quickstart/golang-recommendation.md index c573b2405..982b8cb20 100644 --- a/versioned_docs/version-4.0.0/quickstart/golang-recommendation.md +++ b/versioned_docs/version-4.0.0/quickstart/golang-recommendation.md @@ -9,3 +9,10 @@ hide_table_of_contents: true import QuickStartFilter from '../../../src/components/QuickStartFilter' + +## Related + +- [Sample Product Catalog App (Golang)](/docs/quickstart/samples-mux/) — Mux with Postgres. +- [Sample CRUD App (Golang)](/docs/quickstart/samples-fasthttp/) — FastHttp with Postgres. +- [Sample User Authentication App (Golang)](/docs/quickstart/samples-redis/) — Gin with Redis. +- [Sample URL Shortener App (Golang)](/docs/quickstart/samples-gin/) — Gin with MongoDB. diff --git a/versioned_docs/version-4.0.0/quickstart/java-quickstart-recommendation.md b/versioned_docs/version-4.0.0/quickstart/java-quickstart-recommendation.md index 82bc844da..cfff8f1e9 100644 --- a/versioned_docs/version-4.0.0/quickstart/java-quickstart-recommendation.md +++ b/versioned_docs/version-4.0.0/quickstart/java-quickstart-recommendation.md @@ -9,3 +9,10 @@ hide_table_of_contents: true import QuickStartFilter from '../../../src/components/QuickStartFilter' + +## Related + +- [Sample Rest API with Spring-Boot and MongoDB](/docs/quickstart/java-spring-boot-mongo/) — Spring Boot with MongoDB. +- [Keploy Integration with PetClinic App](/docs/quickstart/pet-clinic/) — Spring Boot with Postgres. +- [Sample REST API with Spring-Boot and XML](/docs/quickstart/java-spring-boot-xml/) — Spring Boot serving XML. +- [Java Sample Application](/docs/quickstart/samples-java/) — another Java sample. diff --git a/versioned_docs/version-4.0.0/quickstart/java-spring-boot-mongo.md b/versioned_docs/version-4.0.0/quickstart/java-spring-boot-mongo.md index 7e52c0deb..f465dba6f 100644 --- a/versioned_docs/version-4.0.0/quickstart/java-spring-boot-mongo.md +++ b/versioned_docs/version-4.0.0/quickstart/java-spring-boot-mongo.md @@ -180,3 +180,10 @@ Final thoughts? Dive deeper! Try different API calls, tweak the DB response in t ## Wrapping it up 🎉 Congrats on the journey so far! You've seen Keploy's power, flexed your coding muscles, and had a bit of fun too! Now, go out there and keep exploring, innovating, and creating! Remember, with the right tools and a sprinkle of fun, anything's possible. 😊🚀 + +## Related + +- [Sample Java Apps](/docs/quickstart/java-springboot-filter/) — browse more Java samples. +- [Keploy Integration with PetClinic App](/docs/quickstart/pet-clinic/) — Spring Boot with Postgres. +- [Sample REST API with Spring-Boot and XML](/docs/quickstart/java-spring-boot-xml/) — Spring Boot serving XML. +- [Keploy with OpenHospital](/docs/quickstart/openhospital/) — larger Spring Boot app. diff --git a/versioned_docs/version-4.0.0/quickstart/java-spring-boot-openhospital.md b/versioned_docs/version-4.0.0/quickstart/java-spring-boot-openhospital.md index 83a78497b..136888b50 100644 --- a/versioned_docs/version-4.0.0/quickstart/java-spring-boot-openhospital.md +++ b/versioned_docs/version-4.0.0/quickstart/java-spring-boot-openhospital.md @@ -150,3 +150,10 @@ Here `delay` is the time it takes for your application to get started, after whi `buildDelay` is the time that it takes for the image to get built. This is useful when you are building the docker image from your docker compose file itself. Hope this helps you out, if you still have any questions, reach out to us . + +## Related + +- [Sample Java Apps](/docs/quickstart/java-springboot-filter/) — browse more Java samples. +- [Keploy Integration with PetClinic App](/docs/quickstart/pet-clinic/) — another Spring Boot Postgres app. +- [Sample Rest API with Spring-Boot and MongoDB](/docs/quickstart/java-spring-boot-mongo/) — Spring Boot with MongoDB. +- [Sample REST API with Spring-Boot and XML](/docs/quickstart/java-spring-boot-xml/) — Spring Boot serving XML. diff --git a/versioned_docs/version-4.0.0/quickstart/java-spring-boot-xml.md b/versioned_docs/version-4.0.0/quickstart/java-spring-boot-xml.md index 4a939ecdc..b5725efa3 100644 --- a/versioned_docs/version-4.0.0/quickstart/java-spring-boot-xml.md +++ b/versioned_docs/version-4.0.0/quickstart/java-spring-boot-xml.md @@ -170,3 +170,10 @@ After updating `keploy.yml` with the above configuration, rerun your tests, and ## Wrapping Up 🎉 Fantastic! You've successfully navigated creating and testing XML APIs with Spring Boot and Keploy. Keep exploring, experimenting, and innovating! If you have any queries, we're here to help! + +## Related + +- [Sample Java Apps](/docs/quickstart/java-springboot-filter/) — browse more Java samples. +- [Sample Rest API with Spring-Boot and MongoDB](/docs/quickstart/java-spring-boot-mongo/) — Spring Boot with MongoDB. +- [Keploy Integration with PetClinic App](/docs/quickstart/pet-clinic/) — Spring Boot with Postgres. +- [Java Sample Application](/docs/quickstart/samples-java/) — another Java sample. diff --git a/versioned_docs/version-4.0.0/quickstart/java-spring-postgres.md b/versioned_docs/version-4.0.0/quickstart/java-spring-postgres.md index f5638750e..a903ccf4a 100644 --- a/versioned_docs/version-4.0.0/quickstart/java-spring-postgres.md +++ b/versioned_docs/version-4.0.0/quickstart/java-spring-postgres.md @@ -212,3 +212,10 @@ Here `delay` is the time it takes for your application to get started, after whi `buildDelay` is the time that it takes for the image to get built. This is useful when you are building the docker image from your docker compose file itself. Hope this helps you out, if you still have any questions, reach out to us . + +## Related + +- [Sample Java Apps](/docs/quickstart/java-springboot-filter/) — browse more Java samples. +- [Keploy with OpenHospital](/docs/quickstart/openhospital/) — another Spring Boot Postgres app. +- [Sample Rest API with Spring-Boot and MongoDB](/docs/quickstart/java-spring-boot-mongo/) — Spring Boot with MongoDB. +- [Sample REST API with Spring-Boot and XML](/docs/quickstart/java-spring-boot-xml/) — Spring Boot serving XML. diff --git a/versioned_docs/version-4.0.0/quickstart/javascript-recommendation.md b/versioned_docs/version-4.0.0/quickstart/javascript-recommendation.md index bad5dc7cd..8141bf3b1 100644 --- a/versioned_docs/version-4.0.0/quickstart/javascript-recommendation.md +++ b/versioned_docs/version-4.0.0/quickstart/javascript-recommendation.md @@ -9,3 +9,10 @@ hide_table_of_contents: true import QuickStartFilter from '../../../src/components/QuickStartFilter'; + +## Related + +- [Node.js Express Mongoose Sample](/docs/quickstart/samples-nodejs/) — Express with MongoDB. +- [NodeJS - JWT Sample Application](/docs/quickstart/samples-node-jwt/) — Node with JWT and Postgres. +- [Express + PostgreSQL + Prisma Sample Application](/docs/quickstart/express-postgresql-prisma/) — Express with Prisma and Postgres. +- [Typescript Sample Application](/docs/quickstart/samples-typescript/) — TypeScript sample app. diff --git a/versioned_docs/version-4.0.0/quickstart/k8s-proxy-developer-workflow.md b/versioned_docs/version-4.0.0/quickstart/k8s-proxy-developer-workflow.md index e4040e71a..a68dad05c 100644 --- a/versioned_docs/version-4.0.0/quickstart/k8s-proxy-developer-workflow.md +++ b/versioned_docs/version-4.0.0/quickstart/k8s-proxy-developer-workflow.md @@ -214,3 +214,9 @@ A typical day with this workflow looks like: 5. CI replays the branch and either passes or asks for review via the approval gate. 6. A reviewer approves the test-data diff in the dashboard. 7. On PR merge, CI runs `keploy cloud branch-merge` and the new test data lands on `main`. + +## Related + +- [K8s Record Replay](/docs/quickstart/k8s-proxy/) — record and replay in Kubernetes. +- [Developer + LLM Workflow with Keploy Proxy](/docs/quickstart/k8s-proxy-llm-workflow/) — the same flow driven by an LLM. +- [E-commerce Microservices](/docs/quickstart/samples-microservices/) — multi-service app to record. diff --git a/versioned_docs/version-4.0.0/quickstart/k8s-proxy-llm-workflow.md b/versioned_docs/version-4.0.0/quickstart/k8s-proxy-llm-workflow.md index d46127f42..872285dcb 100644 --- a/versioned_docs/version-4.0.0/quickstart/k8s-proxy-llm-workflow.md +++ b/versioned_docs/version-4.0.0/quickstart/k8s-proxy-llm-workflow.md @@ -606,3 +606,9 @@ B0 → B1 (`git diff origin/main...HEAD --name-only` surfaces the new route). B2 Across every scenario, you only ever spoke one of two sentences. You push your code change (and, for Case 1, the agent's app-side edit). CI replays the branch on the PR; merge runs `keploy cloud branch-merge` and the test data lands on main. For the same flow done manually (CLI / dashboard, no agent), see [Developer Workflow with Keploy Proxy](/docs/quickstart/k8s-proxy-developer-workflow). + +## Related + +- [K8s Record Replay](/docs/quickstart/k8s-proxy/) — record and replay in Kubernetes. +- [Developer Workflow with Keploy Proxy](/docs/quickstart/k8s-proxy-developer-workflow/) — the same flow done manually. +- [E-commerce Microservices](/docs/quickstart/samples-microservices/) — multi-service app to record. diff --git a/versioned_docs/version-4.0.0/quickstart/k8s-proxy.md b/versioned_docs/version-4.0.0/quickstart/k8s-proxy.md index 73d0189fe..f1129b871 100644 --- a/versioned_docs/version-4.0.0/quickstart/k8s-proxy.md +++ b/versioned_docs/version-4.0.0/quickstart/k8s-proxy.md @@ -343,3 +343,9 @@ After test generation, you can view the total number of test suites categorized In this quickstart, we demonstrated how to use the Keploy Proxy in Kubernetes to record live traffic and generate tests using AI—all without writing manual tests. This is only a quickstart; you can follow the same steps to record real, production-like traffic and generate tests using AI. Happy Testing with Keploy + +## Related + +- [Developer Workflow with Keploy Proxy](/docs/quickstart/k8s-proxy-developer-workflow/) — branch, replay, and gate PRs. +- [Developer + LLM Workflow with Keploy Proxy](/docs/quickstart/k8s-proxy-llm-workflow/) — the same flow driven by an LLM. +- [E-commerce Microservices](/docs/quickstart/samples-microservices/) — multi-service app to record. diff --git a/versioned_docs/version-4.0.0/quickstart/nextjs-postgres.md b/versioned_docs/version-4.0.0/quickstart/nextjs-postgres.md index 202dd1f8a..ff57f65c5 100644 --- a/versioned_docs/version-4.0.0/quickstart/nextjs-postgres.md +++ b/versioned_docs/version-4.0.0/quickstart/nextjs-postgres.md @@ -138,3 +138,10 @@ Final thoughts? Dive deeper! Try different API calls, tweak the DB response in t ### Wrapping it up 🎉 Congrats on the journey so far! You've seen Keploy's power, flexed your coding muscles, and had a bit of fun too! Now, go out there and keep exploring, innovating, and creating! Remember, with the right tools and a sprinkle of fun, anything's possible. 😊🚀 + +## Related + +- [Sample JavaScript Apps](/docs/quickstart/javascript-filter/) — browse more JS samples. +- [Express + PostgreSQL + Prisma Sample Application](/docs/quickstart/express-postgresql-prisma/) — another Postgres JS app. +- [NodeJS - JWT Sample Application](/docs/quickstart/samples-node-jwt/) — Node app on Postgres. +- [Node.js Express Mongoose Sample](/docs/quickstart/samples-nodejs/) — another Node.js sample. diff --git a/versioned_docs/version-4.0.0/quickstart/node-express-mongoose.md b/versioned_docs/version-4.0.0/quickstart/node-express-mongoose.md index 2d514a86c..7a0a426b2 100644 --- a/versioned_docs/version-4.0.0/quickstart/node-express-mongoose.md +++ b/versioned_docs/version-4.0.0/quickstart/node-express-mongoose.md @@ -253,3 +253,10 @@ output should look like ### Wrapping it up 🎉 Congrats on the journey so far! You've seen Keploy's power, flexed your coding muscles, and had a bit of fun too! Now, go out there and keep exploring, innovating, and creating! Remember, with the right tools and a sprinkle of fun, anything's possible.😊🚀 + +## Related + +- [Sample JavaScript Apps](/docs/quickstart/javascript-filter/) — browse more JS samples. +- [Node.js MongoDB Sample](/docs/quickstart/crud-nodejs/) — another Node MongoDB app. +- [sample course selling api (express)](/docs/quickstart/express-mongoose-application/) — Express with Mongoose. +- [NodeJS - JWT Sample Application](/docs/quickstart/samples-node-jwt/) — another Node.js sample. diff --git a/versioned_docs/version-4.0.0/quickstart/node-jwt-sql.md b/versioned_docs/version-4.0.0/quickstart/node-jwt-sql.md index 0a5f923cb..64dca412d 100644 --- a/versioned_docs/version-4.0.0/quickstart/node-jwt-sql.md +++ b/versioned_docs/version-4.0.0/quickstart/node-jwt-sql.md @@ -395,3 +395,10 @@ But wait — one test is still failing due to the time-freezing. To try out the ### Wrapping it up 🎉 Congrats on the journey so far! You've seen Keploy's power, flexed your coding muscles, and had a bit of fun too! Now, go out there and keep exploring, innovating, and creating! Remember, with the right tools and a sprinkle of fun, anything's possible.😊🚀 + +## Related + +- [Sample JavaScript Apps](/docs/quickstart/javascript-filter/) — browse more JS samples. +- [Node.js Express Mongoose Sample](/docs/quickstart/samples-nodejs/) — another Node.js sample. +- [Express + PostgreSQL + Prisma Sample Application](/docs/quickstart/express-postgresql-prisma/) — another Postgres JS app. +- [NextJs Sample Application](/docs/quickstart/samples-nextjs/) — NextJS app on Postgres. diff --git a/versioned_docs/version-4.0.0/quickstart/python-django-sql.md b/versioned_docs/version-4.0.0/quickstart/python-django-sql.md index aab868838..c1a98f718 100644 --- a/versioned_docs/version-4.0.0/quickstart/python-django-sql.md +++ b/versioned_docs/version-4.0.0/quickstart/python-django-sql.md @@ -499,3 +499,10 @@ Final thoughts? Dive deeper! Try different API calls, tweak the DB response in t Congrats on the journey so far! You've seen Keploy's power, flexed your coding muscles, and had a bit of fun too! Now, go out there and keep exploring, innovating, and creating! Remember, with the right tools and a sprinkle of fun, anything's possible. 😊🚀 Hope this helps you out, if you still have any questions, reach out to us . + +## Related + +- [Sample Python Apps](/docs/quickstart/python-filter/) — Browse more Python Keploy samples. +- [Sample Student Data CRUD App](/docs/quickstart/samples-fastapi/) — Another Python SQL CRUD app. +- [Sample Task Creation CRUD App](/docs/quickstart/samples-flask/) — Python Flask CRUD sample. +- [Sample SMS Sending App](/docs/quickstart/samples-fastapi-twilio/) — Python FastAPI external API sample. diff --git a/versioned_docs/version-4.0.0/quickstart/python-fastapi-sql.md b/versioned_docs/version-4.0.0/quickstart/python-fastapi-sql.md index c3d8dedca..11d34f394 100644 --- a/versioned_docs/version-4.0.0/quickstart/python-fastapi-sql.md +++ b/versioned_docs/version-4.0.0/quickstart/python-fastapi-sql.md @@ -426,3 +426,10 @@ Final thoughts? Dive deeper! Try different API calls, tweak the DB response in t ### Wrapping it up 🎉 Congrats on the journey so far! You've seen Keploy's power, flexed your coding muscles, and had a bit of fun too! Now, go out there and keep exploring, innovating, and creating! Remember, with the right tools and a sprinkle of fun, anything's possible. 😊🚀 + +## Related + +- [Sample Python Apps](/docs/quickstart/python-filter/) — Browse more Python Keploy samples. +- [Sample User Data CRUD App (Django)](/docs/quickstart/samples-django/) — Another Python SQL CRUD app. +- [Sample Task Creation CRUD App](/docs/quickstart/samples-flask/) — Python Flask CRUD sample. +- [Sample SMS Sending App](/docs/quickstart/samples-fastapi-twilio/) — FastAPI with external API integration. diff --git a/versioned_docs/version-4.0.0/quickstart/python-fastapi-twilio.md b/versioned_docs/version-4.0.0/quickstart/python-fastapi-twilio.md index af0711f53..594359ef5 100644 --- a/versioned_docs/version-4.0.0/quickstart/python-fastapi-twilio.md +++ b/versioned_docs/version-4.0.0/quickstart/python-fastapi-twilio.md @@ -474,3 +474,10 @@ Final thoughts? Dive deeper! Try different API calls, tweak the Twilio response ### Wrapping it up 🎉 Congrats on the journey so far! You've seen Keploy's power, flexed your coding muscles, and had a bit of fun too! Now, go out there and keep exploring, innovating, and creating! Remember, with the right tools and a sprinkle of fun, anything's possible. 😊🚀 + +## Related + +- [Sample Python Apps](/docs/quickstart/python-filter/) — Browse more Python Keploy samples. +- [Sample Student Data CRUD App](/docs/quickstart/samples-fastapi/) — Another FastAPI sample app. +- [Sample Task Creation CRUD App](/docs/quickstart/samples-flask/) — Python Flask CRUD sample. +- [Sample User Data CRUD App (Django)](/docs/quickstart/samples-django/) — Python Django CRUD sample. diff --git a/versioned_docs/version-4.0.0/quickstart/python-flask-mongo.md b/versioned_docs/version-4.0.0/quickstart/python-flask-mongo.md index 64dc2729a..1a9133719 100644 --- a/versioned_docs/version-4.0.0/quickstart/python-flask-mongo.md +++ b/versioned_docs/version-4.0.0/quickstart/python-flask-mongo.md @@ -233,3 +233,10 @@ python3 -m coverage html ## Wrapping it up 🎉 Congrats on the journey so far! You've seen Keploy's power, flexed your coding muscles, and had a bit of fun too! Now, go out there and keep exploring, innovating, and creating! Remember, with the right tools and a sprinkle of fun, anything's possible.😊🚀 + +## Related + +- [Sample Python Apps](/docs/quickstart/python-filter/) — Browse more Python Keploy samples. +- [Sample Student Data CRUD App](/docs/quickstart/samples-fastapi/) — Python FastAPI CRUD sample. +- [Sample User Data CRUD App (Django)](/docs/quickstart/samples-django/) — Python Django CRUD sample. +- [Sample Movie API with Sanic and MongoDB](/docs/quickstart/sanic-mongo/) — Another Python MongoDB app. diff --git a/versioned_docs/version-4.0.0/quickstart/python-microservices.md b/versioned_docs/version-4.0.0/quickstart/python-microservices.md index 156c8f950..07027d5c6 100644 --- a/versioned_docs/version-4.0.0/quickstart/python-microservices.md +++ b/versioned_docs/version-4.0.0/quickstart/python-microservices.md @@ -2406,18 +2406,18 @@ code={` # Create an order curl --request POST \ - --url http://localhost:8080/api/v1/orders \ - --header 'Connection: keep-alive' \ - --header 'Idempotency-Key: f0f86385-1d98-438c-b5a0-2b70385a4f8e' \ - --header 'User-Agent: PostmanRuntime/7.49.1' \ - --header 'Postman-Token: 24ef30da-b00d-46d6-ba1b-93578987e51a' \ - --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJmMzEwNzA0NC1iYjA1LTExZjAtYTZlMi1hZWVmN2RjNDBlNjYiLCJ1c2VybmFtZSI6ImFkbWluIiwiaWF0IjoxNzYyNTAwNzMzLCJleHAiOjE3NjUwOTI3MzN9.pZejD-sAGDMXW9cgGYnS9ReqG-TXFFFnyQZeMMY*2cQ' \ - --header 'Accept: */\_' \ - --header 'Cache-Control: no-cache' \ - --header 'Host: localhost:8080' \ - --header 'Content-Type: application/json' \ - --header 'Accept-Encoding: gzip, deflate, br' \ - --data '{ +--url http://localhost:8080/api/v1/orders \ +--header 'Connection: keep-alive' \ +--header 'Idempotency-Key: f0f86385-1d98-438c-b5a0-2b70385a4f8e' \ +--header 'User-Agent: PostmanRuntime/7.49.1' \ +--header 'Postman-Token: 24ef30da-b00d-46d6-ba1b-93578987e51a' \ +--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJmMzEwNzA0NC1iYjA1LTExZjAtYTZlMi1hZWVmN2RjNDBlNjYiLCJ1c2VybmFtZSI6ImFkbWluIiwiaWF0IjoxNzYyNTAwNzMzLCJleHAiOjE3NjUwOTI3MzN9.pZejD-sAGDMXW9cgGYnS9ReqG-TXFFFnyQZeMMY*2cQ' \ +--header 'Accept: */\_' \ +--header 'Cache-Control: no-cache' \ +--header 'Host: localhost:8080' \ +--header 'Content-Type: application/json' \ +--header 'Accept-Encoding: gzip, deflate, br' \ +--data '{ "userId": "6b6c9d87-92b0-4007-87ce-6356699648a8", "items": [ { @@ -2431,70 +2431,70 @@ curl --request POST \ # Get last order curl --request GET \ - --url http://localhost:8080/api/v1/orders/%7B%7Blast*order_id%7D%7D \ - --header 'Accept-Encoding: gzip, deflate, br' \ - --header 'Connection: keep-alive' \ - --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJmMzEwNzA0NC1iYjA1LTExZjAtYTZlMi1hZWVmN2RjNDBlNjYiLCJ1c2VybmFtZSI6ImFkbWluIiwiaWF0IjoxNzYyNTAwNzMzLCJleHAiOjE3NjUwOTI3MzN9.pZejD-sAGDMXW9cgGYnS9ReqG-TXFFFnyQZeMMY_2cQ' \ - --header 'User-Agent: PostmanRuntime/7.49.1' \ - --header 'Accept: */\_' \ - --header 'Cache-Control: no-cache' \ - --header 'Postman-Token: 6109e22b-dfb5-4394-b74e-5d0e8ce5466e' \ - --header 'Host: localhost:8080' +--url http://localhost:8080/api/v1/orders/%7B%7Blast*order_id%7D%7D \ +--header 'Accept-Encoding: gzip, deflate, br' \ +--header 'Connection: keep-alive' \ +--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJmMzEwNzA0NC1iYjA1LTExZjAtYTZlMi1hZWVmN2RjNDBlNjYiLCJ1c2VybmFtZSI6ImFkbWluIiwiaWF0IjoxNzYyNTAwNzMzLCJleHAiOjE3NjUwOTI3MzN9.pZejD-sAGDMXW9cgGYnS9ReqG-TXFFFnyQZeMMY_2cQ' \ +--header 'User-Agent: PostmanRuntime/7.49.1' \ +--header 'Accept: */\_' \ +--header 'Cache-Control: no-cache' \ +--header 'Postman-Token: 6109e22b-dfb5-4394-b74e-5d0e8ce5466e' \ +--header 'Host: localhost:8080' # Get last order (alternate call) curl --request GET \ - --url http://localhost:8080/api/v1/orders/%7B%7Blast*order_id%7D%7D \ - --header 'User-Agent: PostmanRuntime/7.49.1' \ - --header 'Accept: */\_' \ - --header 'Cache-Control: no-cache' \ - --header 'Postman-Token: 0f9a2f3e-6248-404a-adbf-74fcb9c68ff7' \ - --header 'Host: localhost:8080' \ - --header 'Accept-Encoding: gzip, deflate, br' \ - --header 'Connection: keep-alive' \ - --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJmMzEwNzA0NC1iYjA1LTExZjAtYTZlMi1hZWVmN2RjNDBlNjYiLCJ1c2VybmFtZSI6ImFkbWluIiwiaWF0IjoxNzYyNTAwNzMzLCJleHAiOjE3NjUwOTI3MzN9.pZejD-sAGDMXW9cgGYnS9ReqG-TXFFFnyQZeMMY_2cQ' +--url http://localhost:8080/api/v1/orders/%7B%7Blast*order_id%7D%7D \ +--header 'User-Agent: PostmanRuntime/7.49.1' \ +--header 'Accept: */\_' \ +--header 'Cache-Control: no-cache' \ +--header 'Postman-Token: 0f9a2f3e-6248-404a-adbf-74fcb9c68ff7' \ +--header 'Host: localhost:8080' \ +--header 'Accept-Encoding: gzip, deflate, br' \ +--header 'Connection: keep-alive' \ +--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJmMzEwNzA0NC1iYjA1LTExZjAtYTZlMi1hZWVmN2RjNDBlNjYiLCJ1c2VybmFtZSI6ImFkbWluIiwiaWF0IjoxNzYyNTAwNzMzLCJleHAiOjE3NjUwOTI3MzN9.pZejD-sAGDMXW9cgGYnS9ReqG-TXFFFnyQZeMMY_2cQ' # Get order details curl --request GET \ - --url http://localhost:8080/api/v1/orders/%7B%7Blast*order_id%7D%7D/details \ - --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJmMzEwNzA0NC1iYjA1LTExZjAtYTZlMi1hZWVmN2RjNDBlNjYiLCJ1c2VybmFtZSI6ImFkbWluIiwiaWF0IjoxNzYyNTAwNzMzLCJleHAiOjE3NjUwOTI3MzN9.pZejD-sAGDMXW9cgGYnS9ReqG-TXFFFnyQZeMMY_2cQ' \ - --header 'User-Agent: PostmanRuntime/7.49.1' \ - --header 'Accept: */\_' \ - --header 'Cache-Control: no-cache' \ - --header 'Postman-Token: 3b8a7f27-4ada-4486-b27c-845d6a874763' \ - --header 'Host: localhost:8080' \ - --header 'Accept-Encoding: gzip, deflate, br' \ - --header 'Connection: keep-alive' +--url http://localhost:8080/api/v1/orders/%7B%7Blast*order_id%7D%7D/details \ +--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJmMzEwNzA0NC1iYjA1LTExZjAtYTZlMi1hZWVmN2RjNDBlNjYiLCJ1c2VybmFtZSI6ImFkbWluIiwiaWF0IjoxNzYyNTAwNzMzLCJleHAiOjE3NjUwOTI3MzN9.pZejD-sAGDMXW9cgGYnS9ReqG-TXFFFnyQZeMMY_2cQ' \ +--header 'User-Agent: PostmanRuntime/7.49.1' \ +--header 'Accept: */\_' \ +--header 'Cache-Control: no-cache' \ +--header 'Postman-Token: 3b8a7f27-4ada-4486-b27c-845d6a874763' \ +--header 'Host: localhost:8080' \ +--header 'Accept-Encoding: gzip, deflate, br' \ +--header 'Connection: keep-alive' # Cancel an order curl --request POST \ - --url http://localhost:8080/api/v1/orders/%7B%7Blast*order_id%7D%7D/cancel \ - --header 'Accept: */\_' \ - --header 'Postman-Token: 9743c0e3-7b2b-4909-818d-6fe73311bc24' \ - --header 'Accept-Encoding: gzip, deflate, br' \ - --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJmMzEwNzA0NC1iYjA1LTExZjAtYTZlMi1hZWVmN2RjNDBlNjYiLCJ1c2VybmFtZSI6ImFkbWluIiwiaWF0IjoxNzYyNTAwNzMzLCJleHAiOjE3NjUwOTI3MzN9.pZejD-sAGDMXW9cgGYnS9ReqG-TXFFFnyQZeMMY_2cQ' \ - --header 'Host: localhost:8080' \ - --header 'Connection: keep-alive' \ - --header 'User-Agent: PostmanRuntime/7.49.1' \ - --header 'Cache-Control: no-cache' +--url http://localhost:8080/api/v1/orders/%7B%7Blast*order_id%7D%7D/cancel \ +--header 'Accept: */\_' \ +--header 'Postman-Token: 9743c0e3-7b2b-4909-818d-6fe73311bc24' \ +--header 'Accept-Encoding: gzip, deflate, br' \ +--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJmMzEwNzA0NC1iYjA1LTExZjAtYTZlMi1hZWVmN2RjNDBlNjYiLCJ1c2VybmFtZSI6ImFkbWluIiwiaWF0IjoxNzYyNTAwNzMzLCJleHAiOjE3NjUwOTI3MzN9.pZejD-sAGDMXW9cgGYnS9ReqG-TXFFFnyQZeMMY_2cQ' \ +--header 'Host: localhost:8080' \ +--header 'Connection: keep-alive' \ +--header 'User-Agent: PostmanRuntime/7.49.1' \ +--header 'Cache-Control: no-cache' # Create another order with new idempotency key curl --request POST \ - --url http://localhost:8080/api/v1/orders \ - --header 'Host: localhost:8080' \ - --header 'Accept-Encoding: gzip, deflate, br' \ - --header 'Accept: _/_' \ - --header 'User-Agent: PostmanRuntime/7.49.1' \ - --header 'Content-Type: application/json' \ - --header 'Postman-Token: d494c3c8-8c24-437f-8ed7-f0d1527bf989' \ - --header 'Idempotency-Key: 2fb62e17-8ace-4528-ab51-0e7cf025237a' \ - --header 'Connection: keep-alive' \ - --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJmMzEwNzA0NC1iYjA1LTExZjAtYTZlMi1hZWVmN2RjNDBlNjYiLCJ1c2VybmFtZSI6ImFkbWluIiwiaWF0IjoxNzYyNTAwNzMzLCJleHAiOjE3NjUwOTI3MzN9.pZejD-sAGDMXW9cgGYnS9ReqG-TXFFFnyQZeMMY_2cQ' \ - --header 'Cache-Control: no-cache' \ - --data '{ +--url http://localhost:8080/api/v1/orders \ +--header 'Host: localhost:8080' \ +--header 'Accept-Encoding: gzip, deflate, br' \ +--header 'Accept: _/_' \ +--header 'User-Agent: PostmanRuntime/7.49.1' \ +--header 'Content-Type: application/json' \ +--header 'Postman-Token: d494c3c8-8c24-437f-8ed7-f0d1527bf989' \ +--header 'Idempotency-Key: 2fb62e17-8ace-4528-ab51-0e7cf025237a' \ +--header 'Connection: keep-alive' \ +--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJmMzEwNzA0NC1iYjA1LTExZjAtYTZlMi1hZWVmN2RjNDBlNjYiLCJ1c2VybmFtZSI6ImFkbWluIiwiaWF0IjoxNzYyNTAwNzMzLCJleHAiOjE3NjUwOTI3MzN9.pZejD-sAGDMXW9cgGYnS9ReqG-TXFFFnyQZeMMY_2cQ' \ +--header 'Cache-Control: no-cache' \ +--data '{ "userId": "6b6c9d87-92b0-4007-87ce-6356699648a8", "items": [ { @@ -2508,28 +2508,28 @@ curl --request POST \ # Pay for an order curl --request POST \ - --url http://localhost:8080/api/v1/orders/%7B%7Blast*order_id%7D%7D/pay \ - --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJmMzEwNzA0NC1iYjA1LTExZjAtYTZlMi1hZWVmN2RjNDBlNjYiLCJ1c2VybmFtZSI6ImFkbWluIiwiaWF0IjoxNzYyNTAwNzMzLCJleHAiOjE3NjUwOTI3MzN9.pZejD-sAGDMXW9cgGYnS9ReqG-TXFFFnyQZeMMY_2cQ' \ - --header 'Accept: */\_' \ - --header 'Postman-Token: 1925ffdf-3aa4-41a3-8b5a-9a7a56c96932' \ - --header 'Accept-Encoding: gzip, deflate, br' \ - --header 'Connection: keep-alive' \ - --header 'Host: localhost:8080' \ - --header 'User-Agent: PostmanRuntime/7.49.1' \ - --header 'Cache-Control: no-cache' +--url http://localhost:8080/api/v1/orders/%7B%7Blast*order_id%7D%7D/pay \ +--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJmMzEwNzA0NC1iYjA1LTExZjAtYTZlMi1hZWVmN2RjNDBlNjYiLCJ1c2VybmFtZSI6ImFkbWluIiwiaWF0IjoxNzYyNTAwNzMzLCJleHAiOjE3NjUwOTI3MzN9.pZejD-sAGDMXW9cgGYnS9ReqG-TXFFFnyQZeMMY_2cQ' \ +--header 'Accept: */\_' \ +--header 'Postman-Token: 1925ffdf-3aa4-41a3-8b5a-9a7a56c96932' \ +--header 'Accept-Encoding: gzip, deflate, br' \ +--header 'Connection: keep-alive' \ +--header 'Host: localhost:8080' \ +--header 'User-Agent: PostmanRuntime/7.49.1' \ +--header 'Cache-Control: no-cache' # Get all orders for a user curl --request GET \ - --url 'http://localhost:8080/api/v1/orders?userId=6b6c9d87-92b0-4007-87ce-6356699648a8' \ - --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJmMzEwNzA0NC1iYjA1LTExZjAtYTZlMi1hZWVmN2RjNDBlNjYiLCJ1c2VybmFtZSI6ImFkbWluIiwiaWF0IjoxNzYyNTAwNzMzLCJleHAiOjE3NjUwOTI3MzN9.pZejD-sAGDMXW9cgGYnS9ReqG-TXFFFnyQZeMMY*2cQ' \ - --header 'User-Agent: PostmanRuntime/7.49.1' \ - --header 'Accept: */\_' \ - --header 'Cache-Control: no-cache' \ - --header 'Postman-Token: 4a3c9621-52ef-48f8-8a9e-01acff2353b0' \ - --header 'Host: localhost:8080' \ - --header 'Accept-Encoding: gzip, deflate, br' \ - --header 'Connection: keep-alive' +--url 'http://localhost:8080/api/v1/orders?userId=6b6c9d87-92b0-4007-87ce-6356699648a8' \ +--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJmMzEwNzA0NC1iYjA1LTExZjAtYTZlMi1hZWVmN2RjNDBlNjYiLCJ1c2VybmFtZSI6ImFkbWluIiwiaWF0IjoxNzYyNTAwNzMzLCJleHAiOjE3NjUwOTI3MzN9.pZejD-sAGDMXW9cgGYnS9ReqG-TXFFFnyQZeMMY*2cQ' \ +--header 'User-Agent: PostmanRuntime/7.49.1' \ +--header 'Accept: */\_' \ +--header 'Cache-Control: no-cache' \ +--header 'Postman-Token: 4a3c9621-52ef-48f8-8a9e-01acff2353b0' \ +--header 'Host: localhost:8080' \ +--header 'Accept-Encoding: gzip, deflate, br' \ +--header 'Connection: keep-alive' ` } /> @@ -2827,3 +2827,10 @@ _Also Paste the OpenAPI schema into the Schema Document section. Once completed, ## Conclusion 🎉 Well done! You’ve seen how Keploy helps test your microservices without writing any code. You've generated test cases, run tests, and checked coverage—all with just a few steps. + +## Related + +- [Sample Python Apps](/docs/quickstart/python-filter/) — Browse more Python Keploy samples. +- [Sample Student Data CRUD App](/docs/quickstart/samples-fastapi/) — Python FastAPI CRUD sample. +- [Sample Task Creation CRUD App](/docs/quickstart/samples-flask/) — Python Flask CRUD sample. +- [Sample User Data CRUD App (Django)](/docs/quickstart/samples-django/) — Python Django CRUD sample. diff --git a/versioned_docs/version-4.0.0/quickstart/python-quickstart-recommendation.md b/versioned_docs/version-4.0.0/quickstart/python-quickstart-recommendation.md index d0f5a0db3..2f4533c1d 100644 --- a/versioned_docs/version-4.0.0/quickstart/python-quickstart-recommendation.md +++ b/versioned_docs/version-4.0.0/quickstart/python-quickstart-recommendation.md @@ -9,3 +9,10 @@ hide_table_of_contents: true import QuickStartFilter from '../../../src/components/QuickStartFilter' + +## Related + +- [Sample Student Data CRUD App](/docs/quickstart/samples-fastapi/) — Python FastAPI CRUD sample. +- [Sample Task Creation CRUD App](/docs/quickstart/samples-flask/) — Python Flask CRUD sample. +- [Sample User Data CRUD App (Django)](/docs/quickstart/samples-django/) — Python Django CRUD sample. +- [Sample Movie API with Sanic and MongoDB](/docs/quickstart/sanic-mongo/) — Python Sanic with MongoDB. diff --git a/versioned_docs/version-4.0.0/quickstart/rust-recommendation.md b/versioned_docs/version-4.0.0/quickstart/rust-recommendation.md index 75b38327a..b5dcbd603 100644 --- a/versioned_docs/version-4.0.0/quickstart/rust-recommendation.md +++ b/versioned_docs/version-4.0.0/quickstart/rust-recommendation.md @@ -9,3 +9,9 @@ hide_table_of_contents: true import QuickStartFilter from '../../../src/components/QuickStartFilter' + +## Related + +- [GraphQL Application with MongoDB](/docs/quickstart/samples-rust/) — a full Rust sample app. +- [CRUD REST API with MongoDB](/docs/quickstart/sample-rust-crud-mongo/) — Rust CRUD sample. +- [Rust Sample Application](/docs/quickstart/samples-rust-wrap/) — Rust wrap-mode sample. diff --git a/versioned_docs/version-4.0.0/quickstart/rust-wrap-mongo.md b/versioned_docs/version-4.0.0/quickstart/rust-wrap-mongo.md index 7a8436c33..2f8ba2c6d 100644 --- a/versioned_docs/version-4.0.0/quickstart/rust-wrap-mongo.md +++ b/versioned_docs/version-4.0.0/quickstart/rust-wrap-mongo.md @@ -134,3 +134,9 @@ sudo -E env PATH=$PATH keploy test -c 'cargo run' _Voila!! Our testcases has passed 🌟_ Hope this helps you out, if you still have any questions, reach out to us . + +## Related + +- [GraphQL Application with MongoDB](/docs/quickstart/samples-rust/) — another Rust + MongoDB sample. +- [CRUD REST API with MongoDB](/docs/quickstart/sample-rust-crud-mongo/) — Rust CRUD walkthrough. +- [Sample Rust Apps](/docs/quickstart/rust-filter/) — browse all Rust quickstarts. diff --git a/versioned_docs/version-4.0.0/quickstart/sample-apps.md b/versioned_docs/version-4.0.0/quickstart/sample-apps.md index 0decb4722..e69a9e2b9 100644 --- a/versioned_docs/version-4.0.0/quickstart/sample-apps.md +++ b/versioned_docs/version-4.0.0/quickstart/sample-apps.md @@ -16,3 +16,9 @@ import QuickStartFilter from '../../../src/components/QuickStartFilter' Find the right quickstart for your project 👇 + +## Related + +- [Sample Golang Apps](/docs/quickstart/golang-filter/) — Go quickstarts. +- [Sample Python Apps](/docs/quickstart/python-filter/) — Python quickstarts. +- [Sample JavaScript Apps](/docs/quickstart/javascript-filter/) — JavaScript quickstarts. diff --git a/versioned_docs/version-4.0.0/quickstart/sample-rust-crud-mongo.md b/versioned_docs/version-4.0.0/quickstart/sample-rust-crud-mongo.md index 94525358f..eaeca51aa 100644 --- a/versioned_docs/version-4.0.0/quickstart/sample-rust-crud-mongo.md +++ b/versioned_docs/version-4.0.0/quickstart/sample-rust-crud-mongo.md @@ -138,3 +138,9 @@ We get the following output in the terminal - ![TestRun](/img/rust-mongo-rest-test-run-2.png?raw=true) _Voila!! Our testcases has passed 🌟_ + +## Related + +- [GraphQL Application with MongoDB](/docs/quickstart/samples-rust/) — another Rust + MongoDB sample. +- [Rust Sample Application](/docs/quickstart/samples-rust-wrap/) — Rust wrap-mode sample. +- [Sample Rust Apps](/docs/quickstart/rust-filter/) — browse all Rust quickstarts. diff --git a/versioned_docs/version-4.0.0/quickstart/sample-ts.md b/versioned_docs/version-4.0.0/quickstart/sample-ts.md index 75c466ce7..a8d4980fa 100644 --- a/versioned_docs/version-4.0.0/quickstart/sample-ts.md +++ b/versioned_docs/version-4.0.0/quickstart/sample-ts.md @@ -336,3 +336,9 @@ This is what your response should look like! 🎉 **Congratulations on Reaching This Milestone!** 🎉 You've successfully tested the tool and created your mocks and test cases—fantastic work! Now that you've laid a solid foundation, it's time to elevate your achievements even further. + +## Related + +- [Node.js Express Mongoose Sample](/docs/quickstart/samples-nodejs/) — a related Node/JS sample. +- [BunJS Sample Application](/docs/quickstart/samples-bunjs/) — TypeScript-friendly Bun runtime. +- [Sample JavaScript Apps](/docs/quickstart/javascript-filter/) — browse all JS/TS quickstarts. diff --git a/versioned_docs/version-4.0.0/quickstart/samples-bunjs.md b/versioned_docs/version-4.0.0/quickstart/samples-bunjs.md index 1863a99fc..017a98560 100644 --- a/versioned_docs/version-4.0.0/quickstart/samples-bunjs.md +++ b/versioned_docs/version-4.0.0/quickstart/samples-bunjs.md @@ -402,3 +402,9 @@ Final thoughts? Dive deeper! Try different API calls, tweak the DB response in t ### Wrapping it up 🎉 Congrats on the journey so far! You've seen Keploy's power, flexed your coding muscles, and had a bit of fun too! Now, go out there and keep exploring, innovating, and creating! Remember, with the right tools and a sprinkle of fun, anything's possible. 😊🚀 + +## Related + +- [Typescript Sample Application](/docs/quickstart/samples-typescript/) — TypeScript on Node. +- [Node.js Express Mongoose Sample](/docs/quickstart/samples-nodejs/) — Node/Express counterpart. +- [Sample JavaScript Apps](/docs/quickstart/javascript-filter/) — browse all JS/TS quickstarts. diff --git a/versioned_docs/version-4.0.0/quickstart/samples-echo.md b/versioned_docs/version-4.0.0/quickstart/samples-echo.md index 0ea3e2b9e..44f755860 100644 --- a/versioned_docs/version-4.0.0/quickstart/samples-echo.md +++ b/versioned_docs/version-4.0.0/quickstart/samples-echo.md @@ -243,3 +243,9 @@ We will get output something like this: Congrats on the journey so far! You've seen Keploy's power, flexed your coding muscles, and had a bit of fun too! Now, go out there and keep exploring, innovating, and creating! Remember, with the right tools and a sprinkle of fun, anything's possible.😊🚀 Hope this helps you out, if you still have any questions, reach out to us . + +## Related + +- [Sample Product Catalog App (Golang)](/docs/quickstart/samples-mux/) — another Go sample. +- [Mux MySQL Sample Application](/docs/quickstart/samples-mysql/) — Go + MySQL sample. +- [Sample Golang Apps](/docs/quickstart/golang-filter/) — browse all Go quickstarts. diff --git a/versioned_docs/version-4.0.0/quickstart/samples-express-mongoose.md b/versioned_docs/version-4.0.0/quickstart/samples-express-mongoose.md index 4fee34a98..9e04ddbc5 100644 --- a/versioned_docs/version-4.0.0/quickstart/samples-express-mongoose.md +++ b/versioned_docs/version-4.0.0/quickstart/samples-express-mongoose.md @@ -310,3 +310,9 @@ npm run coverage Congrats on the journey so far! You've seen Keploy's power, flexed your coding muscles, and had a bit of fun too! Now, go out there and keep exploring, innovating, and creating! Remember, with the right tools and a sprinkle of fun, anything's possible.😊🚀 Happy coding! ✨👩‍💻👨‍💻✨ + +## Related + +- [Node.js MongoDB Sample](/docs/quickstart/crud-nodejs/) — Node + MongoDB CRUD. +- [Node.js Express Mongoose Sample](/docs/quickstart/samples-nodejs/) — closely related Express app. +- [Sample JavaScript Apps](/docs/quickstart/javascript-filter/) — browse all JS quickstarts. diff --git a/versioned_docs/version-4.0.0/quickstart/samples-go-gin-mongo.md b/versioned_docs/version-4.0.0/quickstart/samples-go-gin-mongo.md index b78fe94f2..ac6f821f4 100644 --- a/versioned_docs/version-4.0.0/quickstart/samples-go-gin-mongo.md +++ b/versioned_docs/version-4.0.0/quickstart/samples-go-gin-mongo.md @@ -434,3 +434,9 @@ Final thoughts? Dive deeper! Try different API calls, tweak the DB response in t Congrats on the journey so far! You've seen Keploy's power, flexed your coding muscles, and had a bit of fun too! Now, go out there and keep exploring, innovating, and creating! Remember, with the right tools and a sprinkle of fun, anything's possible. 😊🚀 Hope this helps you out, if you still have any questions, reach out to us . + +## Related + +- [Sample User Authentication App (Golang)](/docs/quickstart/samples-redis/) — Go + Redis sample. +- [Sample Product Catalog App (Golang)](/docs/quickstart/samples-mux/) — Go + SQL sample. +- [Sample Golang Apps](/docs/quickstart/golang-filter/) — browse all Go quickstarts. diff --git a/versioned_docs/version-4.0.0/quickstart/samples-go-sse-svelte.md b/versioned_docs/version-4.0.0/quickstart/samples-go-sse-svelte.md index 1b21888e2..033c0efbc 100644 --- a/versioned_docs/version-4.0.0/quickstart/samples-go-sse-svelte.md +++ b/versioned_docs/version-4.0.0/quickstart/samples-go-sse-svelte.md @@ -124,3 +124,9 @@ Output should look like : - ![Testrun](https://github.com/keploy/samples-go/raw/main/sse-svelte/img/testrun.png?raw=true) So no need to setup fake database/apis like Postgres or write mocks for them. Keploy automatically mocks them and, **The application thinks it's talking to MongoDb 😄**. And with just few clicks we were able to get 42% code coverage of our go backend application. + +## Related + +- [Sample URL Shortener App (Golang)](/docs/quickstart/samples-gin/) — another Go + Gin sample. +- [Sample Product Catalog App (Golang)](/docs/quickstart/samples-mux/) — Go + SQL sample. +- [Sample Golang Apps](/docs/quickstart/golang-filter/) — browse all Go quickstarts. diff --git a/versioned_docs/version-4.0.0/quickstart/samples-java.md b/versioned_docs/version-4.0.0/quickstart/samples-java.md index 178f316a2..5c01fdab8 100644 --- a/versioned_docs/version-4.0.0/quickstart/samples-java.md +++ b/versioned_docs/version-4.0.0/quickstart/samples-java.md @@ -338,3 +338,9 @@ Here `delay` is the time it takes for your application to get started, after whi ### 🎉 Wrapping it up Congrats on the journey so far! You've seen Keploy's power, flexed your coding muscles, and had a bit of fun too! Now, go out there and keep exploring, innovating, and creating! Remember, with the right tools and a sprinkle of fun, anything's possible. 😊🚀 + +## Related + +- [Sample Rest API with Spring-Boot and MongoDB](/docs/quickstart/java-spring-boot-mongo/) — Spring Boot + Mongo. +- [Sample REST API with Spring-Boot and XML](/docs/quickstart/java-spring-boot-xml/) — Spring Boot + XML. +- [Sample Java Apps](/docs/quickstart/java-springboot-filter/) — browse all Java quickstarts. diff --git a/versioned_docs/version-4.0.0/quickstart/samples-node-mongo.md b/versioned_docs/version-4.0.0/quickstart/samples-node-mongo.md index 5cd4f87ac..76d57f8c8 100644 --- a/versioned_docs/version-4.0.0/quickstart/samples-node-mongo.md +++ b/versioned_docs/version-4.0.0/quickstart/samples-node-mongo.md @@ -295,3 +295,9 @@ npm run coverage Congratulations! You've conquered Keploy and unleashed its power for effortless testing in your NodeJS application. With Jest by your side, you can ensure rock-solid code coverage. Time to go forth and build amazing things! 🧑🏻‍💻 Hope this helps you out, if you still have any questions, reach out to us . + +## Related + +- [Node.js Express Mongoose Sample](/docs/quickstart/samples-nodejs/) — Express + Mongoose variant. +- [sample course selling api (express)](/docs/quickstart/express-mongoose-application/) — another Express + Mongo app. +- [Sample JavaScript Apps](/docs/quickstart/javascript-filter/) — browse all JS quickstarts. diff --git a/versioned_docs/version-4.0.0/quickstart/samples-rust.md b/versioned_docs/version-4.0.0/quickstart/samples-rust.md index 331fa0e3c..0fcd9a93d 100644 --- a/versioned_docs/version-4.0.0/quickstart/samples-rust.md +++ b/versioned_docs/version-4.0.0/quickstart/samples-rust.md @@ -97,3 +97,9 @@ sudo -E env PATH=$PATH keploy test -c 'cargo run' _Voila!! Our testcases has passed 🌟_ Hope this helps you out, if you still have any questions, reach out to us . + +## Related + +- [CRUD REST API with MongoDB](/docs/quickstart/sample-rust-crud-mongo/) — Rust CRUD sample. +- [Rust Sample Application](/docs/quickstart/samples-rust-wrap/) — Rust wrap-mode sample. +- [Sample Rust Apps](/docs/quickstart/rust-filter/) — browse all Rust quickstarts. diff --git a/versioned_docs/version-4.0.0/quickstart/sanic-mongo.md b/versioned_docs/version-4.0.0/quickstart/sanic-mongo.md index e70c831b3..b70687250 100644 --- a/versioned_docs/version-4.0.0/quickstart/sanic-mongo.md +++ b/versioned_docs/version-4.0.0/quickstart/sanic-mongo.md @@ -196,3 +196,9 @@ This is how your terminal would look like : Sample Keploy Test Sanic Mongo You can experiment with different API calls, modify the database response in mocks.yml, or adjust the request or response in test-x.yml. Then, run the tests again to see the change in response + +## Related + +- [Sample Student Data CRUD App](/docs/quickstart/samples-fastapi/) — another Python async API. +- [Sample Task Creation CRUD App](/docs/quickstart/samples-flask/) — Python + Mongo CRUD. +- [Sample Python Apps](/docs/quickstart/python-filter/) — browse all Python quickstarts. From 96e82dccdc3b2cb4fc65aa848ebef065afb317dd Mon Sep 17 00:00:00 2001 From: dhananjay6561 Date: Mon, 10 Aug 2026 19:10:12 +0530 Subject: [PATCH 19/26] docs(A4): add "Related" cross-links to keploy-cloud docs Add a "Related" section to keploy-cloud pages that had a single internal link, linking sibling cloud features. Build-verified routes. Signed-off-by: dhananjay6561 --- versioned_docs/version-4.0.0/keploy-cloud/deduplication.md | 7 +++++++ versioned_docs/version-4.0.0/keploy-cloud/gitops-argocd.md | 7 +++++++ versioned_docs/version-4.0.0/keploy-cloud/gitops-flux.md | 7 +++++++ versioned_docs/version-4.0.0/keploy-cloud/installation.md | 7 +++++++ .../version-4.0.0/keploy-cloud/keploy-console.md | 7 +++++++ .../version-4.0.0/keploy-cloud/kubernetes-local-setup.md | 7 +++++++ versioned_docs/version-4.0.0/keploy-cloud/kubernetes.md | 6 ++++++ versioned_docs/version-4.0.0/keploy-cloud/mock-registry.md | 6 ++++++ .../version-4.0.0/keploy-cloud/new-application.md | 6 ++++++ .../version-4.0.0/keploy-cloud/testgeneration.md | 6 ++++++ versioned_docs/version-4.0.0/keploy-cloud/time-freezing.md | 6 ++++++ 11 files changed, 72 insertions(+) diff --git a/versioned_docs/version-4.0.0/keploy-cloud/deduplication.md b/versioned_docs/version-4.0.0/keploy-cloud/deduplication.md index 75795233a..840bfb0bf 100644 --- a/versioned_docs/version-4.0.0/keploy-cloud/deduplication.md +++ b/versioned_docs/version-4.0.0/keploy-cloud/deduplication.md @@ -261,3 +261,10 @@ This reads `dedupData.yaml` and writes `duplicates.yaml`, listing the testcases ```bash keploy dedup --rm ``` + +## Related + +- [Static Deduplication](/docs/keploy-cloud/static-deduplication/) — drop duplicate shapes at record time. +- [Auto Test Generation](/docs/keploy-cloud/auto-test-generation/) — generate tests from an OpenAPI schema. +- [Cloud Replay Command Reference](/docs/keploy-cloud/cloud-replay/) — replay with the `--dedup` flag. +- [LLM Workflow (Smart Tests)](/docs/keploy-cloud/smart-set-agent/) — deduplicated smart-set workflow. diff --git a/versioned_docs/version-4.0.0/keploy-cloud/gitops-argocd.md b/versioned_docs/version-4.0.0/keploy-cloud/gitops-argocd.md index 9ca0c6fe4..61365fcbd 100644 --- a/versioned_docs/version-4.0.0/keploy-cloud/gitops-argocd.md +++ b/versioned_docs/version-4.0.0/keploy-cloud/gitops-argocd.md @@ -322,3 +322,10 @@ To add Keploy to an existing ArgoCD setup, you need: | Kubernetes Secret | `kubectl create secret` (manual) | Access key for Keploy cloud authentication | Your existing application code, manifests, and ArgoCD Applications remain **completely untouched**. Keploy works alongside your app—not inside it. + +## Related + +- [Deploy Keploy with Flux CD](/docs/keploy-cloud/gitops-flux/) — the same deployment with Flux GitOps. +- [Kubernetes Setup](/docs/keploy-cloud/kubernetes/) — prerequisite cluster and k8s-proxy setup. +- [Kubernetes Local Setup (Kind)](/docs/keploy-cloud/kubernetes-local-setup/) — spin up a local Kind cluster. +- [Keploy Enterprise Installation](/docs/keploy-cloud/cloud-installation/) — install the Enterprise agent. diff --git a/versioned_docs/version-4.0.0/keploy-cloud/gitops-flux.md b/versioned_docs/version-4.0.0/keploy-cloud/gitops-flux.md index 4a519b053..40ff6f2ae 100644 --- a/versioned_docs/version-4.0.0/keploy-cloud/gitops-flux.md +++ b/versioned_docs/version-4.0.0/keploy-cloud/gitops-flux.md @@ -260,3 +260,10 @@ To add Keploy to an existing Flux setup, you need: | Kubernetes Secret | `kubectl create secret` (manual) | Access key for Keploy cloud authentication | Your existing application manifests and Flux configurations remain **completely untouched**. Keploy works alongside your app—not inside it. + +## Related + +- [Deploy Keploy with ArgoCD](/docs/keploy-cloud/gitops-argocd/) — the same deployment with ArgoCD GitOps. +- [Kubernetes Setup](/docs/keploy-cloud/kubernetes/) — prerequisite cluster and k8s-proxy setup. +- [Kubernetes Local Setup (Kind)](/docs/keploy-cloud/kubernetes-local-setup/) — spin up a local Kind cluster. +- [Keploy Enterprise Installation](/docs/keploy-cloud/cloud-installation/) — install the Enterprise agent. diff --git a/versioned_docs/version-4.0.0/keploy-cloud/installation.md b/versioned_docs/version-4.0.0/keploy-cloud/installation.md index decffbc36..d9d918b91 100644 --- a/versioned_docs/version-4.0.0/keploy-cloud/installation.md +++ b/versioned_docs/version-4.0.0/keploy-cloud/installation.md @@ -71,3 +71,10 @@ b1dNl.... ``` Once the API key is successfully validated, the Keploy Enterprise Agent will begin recording API calls. + +## Related + +- [Kubernetes Setup](/docs/keploy-cloud/kubernetes/) — connect a cluster for live record and replay. +- [Keploy Cloud Application Settings Guide](/docs/keploy-cloud/application-settings/) — add your first application. +- [Keploy Console](/docs/keploy-cloud/keploy-console/) — visualize and edit test results. +- [Time Freezing](/docs/keploy-cloud/time-freezing/) — keep time-sensitive tests reliable. diff --git a/versioned_docs/version-4.0.0/keploy-cloud/keploy-console.md b/versioned_docs/version-4.0.0/keploy-cloud/keploy-console.md index 41d4e3d6e..af98a1292 100644 --- a/versioned_docs/version-4.0.0/keploy-cloud/keploy-console.md +++ b/versioned_docs/version-4.0.0/keploy-cloud/keploy-console.md @@ -81,6 +81,13 @@ You'd see the changes in the test-case file locally, new noisy fields are added Similarly, if the test case result is the new expected response, we can normalise the test report or a particular test case. This will update the expected result of the test case locally. +## Related + +- [Keploy Enterprise Installation](/docs/keploy-cloud/cloud-installation/) — prerequisite before starting the console. +- [Keploy Cloud Application Settings Guide](/docs/keploy-cloud/application-settings/) — add an application to the console. +- [Mock Registry](/docs/keploy-cloud/mock-registry/) — manage mocks used during test runs. +- [Time Freezing](/docs/keploy-cloud/time-freezing/) — stabilize time-sensitive test results. + ## Need Help? If you have any questions or need assistance, our support team is here to help. You can reach out to us through our support portal, Slack or by emailing us. diff --git a/versioned_docs/version-4.0.0/keploy-cloud/kubernetes-local-setup.md b/versioned_docs/version-4.0.0/keploy-cloud/kubernetes-local-setup.md index 41d1e998d..9161f7eb9 100644 --- a/versioned_docs/version-4.0.0/keploy-cloud/kubernetes-local-setup.md +++ b/versioned_docs/version-4.0.0/keploy-cloud/kubernetes-local-setup.md @@ -237,3 +237,10 @@ kube-system coredns-7d764666f9-r82lr 1/1 R ✅ Once deployments are visible, you can start **recording on any Pod** and later **replay**. ![Keploy Kubernetes Interface](/img/k8s-local-cluster-ui.png) + +## Related + +- [Kubernetes Setup](/docs/keploy-cloud/kubernetes/) — full cluster setup including ingress and GitOps. +- [Deploy Keploy with ArgoCD](/docs/keploy-cloud/gitops-argocd/) — deploy the k8s-proxy declaratively with ArgoCD. +- [Deploy Keploy with Flux CD](/docs/keploy-cloud/gitops-flux/) — deploy the k8s-proxy declaratively with Flux. +- [Keploy Enterprise Installation](/docs/keploy-cloud/cloud-installation/) — install the Enterprise agent. diff --git a/versioned_docs/version-4.0.0/keploy-cloud/kubernetes.md b/versioned_docs/version-4.0.0/keploy-cloud/kubernetes.md index e5414384f..7587aae47 100644 --- a/versioned_docs/version-4.0.0/keploy-cloud/kubernetes.md +++ b/versioned_docs/version-4.0.0/keploy-cloud/kubernetes.md @@ -653,3 +653,9 @@ curl -sk https://:30080/healthz ``` ✅ Open the Keploy UI → **Clusters** → your cluster should show as **Connected**. You can now record and replay traffic on any deployment. + +## Related + +- [Kubernetes Local Setup (Kind)](/docs/keploy-cloud/kubernetes-local-setup/) — spin up a local Kind cluster. +- [Keploy Enterprise Installation](/docs/keploy-cloud/cloud-installation/) — install the Enterprise agent. +- [Deploy Keploy with ArgoCD](/docs/keploy-cloud/gitops-argocd/) — GitOps deployment on the cluster. diff --git a/versioned_docs/version-4.0.0/keploy-cloud/mock-registry.md b/versioned_docs/version-4.0.0/keploy-cloud/mock-registry.md index bc868bebf..e1ac55506 100644 --- a/versioned_docs/version-4.0.0/keploy-cloud/mock-registry.md +++ b/versioned_docs/version-4.0.0/keploy-cloud/mock-registry.md @@ -85,3 +85,9 @@ Public mocks are accessible by all users and can be shared across multiple proje #### Private Mocks 🔐 Private mocks are restricted to specific users or projects. Use private mocks for sensitive or project-specific data to ensure security and privacy. + +## Related + +- [Dynamic Deduplication](/docs/keploy-cloud/deduplication/) — remove duplicate recorded interactions. +- [Static Deduplication](/docs/keploy-cloud/static-deduplication/) — dedupe without running tests. +- [Keploy Console](/docs/keploy-cloud/keploy-console/) — manage mocks and suites in the console. diff --git a/versioned_docs/version-4.0.0/keploy-cloud/new-application.md b/versioned_docs/version-4.0.0/keploy-cloud/new-application.md index c5b1d1d3b..eacc3066b 100644 --- a/versioned_docs/version-4.0.0/keploy-cloud/new-application.md +++ b/versioned_docs/version-4.0.0/keploy-cloud/new-application.md @@ -48,3 +48,9 @@ Finally, edit the default [Keploy Config](/docs/running-keploy/configuration-fil ### Need Help? If you have any questions or need assistance, our support team is here to help. You can reach out to us through our support portal, Slack or by emailing us. + +## Related + +- [Keploy Console](/docs/keploy-cloud/keploy-console/) — where applications are managed. +- [Keploy Enterprise Installation](/docs/keploy-cloud/cloud-installation/) — install before adding an app. +- [Auto Test Generation](/docs/keploy-cloud/auto-test-generation/) — generate tests for the new app. diff --git a/versioned_docs/version-4.0.0/keploy-cloud/testgeneration.md b/versioned_docs/version-4.0.0/keploy-cloud/testgeneration.md index 07f1cc5ee..bf4d28a01 100644 --- a/versioned_docs/version-4.0.0/keploy-cloud/testgeneration.md +++ b/versioned_docs/version-4.0.0/keploy-cloud/testgeneration.md @@ -436,3 +436,9 @@ keploy generate-tests -c "java -jar " -s "schema.json" We will get similar output: - image + +## Related + +- [Keploy Console](/docs/keploy-cloud/keploy-console/) — trigger and view generation. +- [LLM Workflow (Smart Tests)](/docs/keploy-cloud/smart-set-agent/) — smarter AI-driven generation. +- [Keploy Cloud Application Settings Guide](/docs/keploy-cloud/application-settings/) — configure the app first. diff --git a/versioned_docs/version-4.0.0/keploy-cloud/time-freezing.md b/versioned_docs/version-4.0.0/keploy-cloud/time-freezing.md index d919b48bf..106227d8c 100644 --- a/versioned_docs/version-4.0.0/keploy-cloud/time-freezing.md +++ b/versioned_docs/version-4.0.0/keploy-cloud/time-freezing.md @@ -142,3 +142,9 @@ keploy test -c "" --freeze-time ``` Voila! Your tests will now run with time freezing enabled. + +## Related + +- [Dynamic Deduplication](/docs/keploy-cloud/deduplication/) — related test-stability feature. +- [Static Deduplication](/docs/keploy-cloud/static-deduplication/) — dedupe recorded tests. +- [Mock Registry](/docs/keploy-cloud/mock-registry/) — manage the mocks time-freezing relies on. From 6e6b4bec92d4932ab6f6c30a1ab93c063d1a04c9 Mon Sep 17 00:00:00 2001 From: dhananjay6561 Date: Mon, 10 Aug 2026 19:10:12 +0530 Subject: [PATCH 20/26] docs(A4): add "Related" cross-links to keploy-explained docs Add a "Related" section to keploy-explained pages, linking sibling concept/FAQ/setup docs. Build-verified routes. Signed-off-by: dhananjay6561 --- .../version-4.0.0/keploy-explained/ai-models.md | 7 +++++++ .../version-4.0.0/keploy-explained/api-testing-faq.md | 7 +++++++ .../version-4.0.0/keploy-explained/common-errors.md | 7 +++++++ .../version-4.0.0/keploy-explained/debugger-guide.md | 7 +++++++ .../version-4.0.0/keploy-explained/dev-guide.md | 7 +++++++ .../version-4.0.0/keploy-explained/docs-dev-guide.md | 6 ++++++ .../version-4.0.0/keploy-explained/how-keploy-works.md | 6 ++++++ .../keploy-explained/integration-testing-faq.md | 6 ++++++ .../version-4.0.0/keploy-explained/integrations-vscode.md | 8 +++++++- .../version-4.0.0/keploy-explained/introduction.md | 6 ++++++ .../version-4.0.0/keploy-explained/keploy-privacy.md | 6 ++++++ .../version-4.0.0/keploy-explained/keploy-security.md | 6 ++++++ .../version-4.0.0/keploy-explained/mac-linux.md | 6 ++++++ .../version-4.0.0/keploy-explained/supported-languages.md | 6 ++++++ .../version-4.0.0/keploy-explained/testing-guide.md | 6 ++++++ .../version-4.0.0/keploy-explained/unit-testing-faq.md | 6 ++++++ .../version-4.0.0/keploy-explained/utg-best-practices.md | 6 ++++++ .../version-4.0.0/keploy-explained/why-keploy.md | 6 ++++++ 18 files changed, 114 insertions(+), 1 deletion(-) diff --git a/versioned_docs/version-4.0.0/keploy-explained/ai-models.md b/versioned_docs/version-4.0.0/keploy-explained/ai-models.md index 58513df5c..f0c2717f9 100644 --- a/versioned_docs/version-4.0.0/keploy-explained/ai-models.md +++ b/versioned_docs/version-4.0.0/keploy-explained/ai-models.md @@ -38,3 +38,10 @@ By combining different models, Keploy can generate better test cases, filter out - **Model Selection:** We choose models for you automatically, but always with a focus on security, reliability, and test quality. Want to learn more about how AI powers Keploy? [Contact us](mailto:support@keploy.io) + +## Related + +- [Unit Testing FAQ](/docs/keploy-explained/unit-testing-faq/) — which AI models power test generation. +- [API Testing – Frequently Asked Questions](/docs/keploy-explained/api-testing-faq/) — how AI handles API testing. +- [Supported Languages for Unit Testing](/docs/keploy-explained/supported-languages/) — languages our AI supports. +- [Code Privacy & Data Protection](/docs/keploy-explained/keploy-privacy/) — your code never trains models. diff --git a/versioned_docs/version-4.0.0/keploy-explained/api-testing-faq.md b/versioned_docs/version-4.0.0/keploy-explained/api-testing-faq.md index fa82c39ea..47d86d08e 100644 --- a/versioned_docs/version-4.0.0/keploy-explained/api-testing-faq.md +++ b/versioned_docs/version-4.0.0/keploy-explained/api-testing-faq.md @@ -102,3 +102,10 @@ Have questions or need a security report for your team? [Contact us!](mailto:sup Your code, your data, your control. 🔐 Hope this helps you out, if you still have any questions, reach out to us . + +## Related + +- [Integration Testing FAQ](/docs/keploy-explained/integration-testing-faq/) — questions on integration testing. +- [Unit Testing FAQ](/docs/keploy-explained/unit-testing-faq/) — questions on unit test generation. +- [How Keploy Works?](/docs/keploy-explained/how-keploy-works/) — the architecture behind API testing. +- [Keploy Troubleshooting Guide](/docs/keploy-explained/common-errors/) — fix common recording and replay errors. diff --git a/versioned_docs/version-4.0.0/keploy-explained/common-errors.md b/versioned_docs/version-4.0.0/keploy-explained/common-errors.md index 18adb288e..ab184db1b 100644 --- a/versioned_docs/version-4.0.0/keploy-explained/common-errors.md +++ b/versioned_docs/version-4.0.0/keploy-explained/common-errors.md @@ -227,3 +227,10 @@ See [MySQL port detection](../running-keploy/configuration-file.md#mysql-port-de If you’re still encountering issues after trying these solutions, feel free to reach out to the Keploy team on [Slack](https://keploy.io/slack). Happy Testing! + +## Related + +- [Debugger Guide](/docs/keploy-explained/debugger-guide/) — debug Keploy with the VS Code debugger. +- [Running Keploy Natively on Windows](/docs/keploy-explained/windows-wsl/) — Windows setup and fixes. +- [Running Keploy Natively on MacOS by setting up a linux env](/docs/keploy-explained/mac-linux/) — macOS setup with Lima. +- [API Testing – Frequently Asked Questions](/docs/keploy-explained/api-testing-faq/) — common API testing questions. diff --git a/versioned_docs/version-4.0.0/keploy-explained/debugger-guide.md b/versioned_docs/version-4.0.0/keploy-explained/debugger-guide.md index 4a2204fbf..00f90abe3 100644 --- a/versioned_docs/version-4.0.0/keploy-explained/debugger-guide.md +++ b/versioned_docs/version-4.0.0/keploy-explained/debugger-guide.md @@ -100,3 +100,10 @@ You can either add more objects in the "configurations" array or modify the "arg Click the **Start Debugging** button to witness the magic of debugging unfold seamlessly. Hope this helps you out, if you still have any questions, reach out to us . + +## Related + +- [Testing Guide](/docs/keploy-explained/testing-guide/) — how Keploy's test bench works. +- [Contribution Guide](/docs/keploy-explained/contribution-guide/) — set up Keploy locally for development. +- [Keploy Troubleshooting Guide](/docs/keploy-explained/common-errors/) — resolve common errors while debugging. +- [IDE Integrations — VS Code](/docs/keploy-explained/integrations-vscode/) — Keploy inside VS Code. diff --git a/versioned_docs/version-4.0.0/keploy-explained/dev-guide.md b/versioned_docs/version-4.0.0/keploy-explained/dev-guide.md index a4a6b6b79..61ed70d3f 100644 --- a/versioned_docs/version-4.0.0/keploy-explained/dev-guide.md +++ b/versioned_docs/version-4.0.0/keploy-explained/dev-guide.md @@ -310,3 +310,10 @@ curl --silent -O -L https://keploy.io/install.sh && source install.sh --oss + +## Related + +- [Keploy Docs Contribution Guide](/docs/keploy-explained/docs-dev-guide/) — contribute to the documentation. +- [Testing Guide](/docs/keploy-explained/testing-guide/) — how Keploy's test bench works. +- [Debugger Guide](/docs/keploy-explained/debugger-guide/) — debug Keploy while developing. +- [How Keploy Works?](/docs/keploy-explained/how-keploy-works/) — the internal architecture. diff --git a/versioned_docs/version-4.0.0/keploy-explained/docs-dev-guide.md b/versioned_docs/version-4.0.0/keploy-explained/docs-dev-guide.md index 1e5bbf2a4..8fec24ab7 100644 --- a/versioned_docs/version-4.0.0/keploy-explained/docs-dev-guide.md +++ b/versioned_docs/version-4.0.0/keploy-explained/docs-dev-guide.md @@ -166,3 +166,9 @@ If you have ideas on how we can improve, please share them with us by creating a Right now our interfaces do not support translations and we also don't have a translation strategy in place. But we want to change this. We want our projects to be accessible to non-English speakers. If you have any ideas then please share them with us by creating a [new issue]. Hope this helps you out, if you still have any questions, reach out to us + +## Related + +- [Contribution Guide](/docs/keploy-explained/contribution-guide/) — contribute to Keploy itself. +- [How Keploy Works?](/docs/keploy-explained/how-keploy-works/) — architecture background for contributors. +- [What is Keploy?](/docs/keploy-explained/introduction/) — project overview. diff --git a/versioned_docs/version-4.0.0/keploy-explained/how-keploy-works.md b/versioned_docs/version-4.0.0/keploy-explained/how-keploy-works.md index c5dee3380..4d087b5ee 100644 --- a/versioned_docs/version-4.0.0/keploy-explained/how-keploy-works.md +++ b/versioned_docs/version-4.0.0/keploy-explained/how-keploy-works.md @@ -69,3 +69,9 @@ Consider an application server serving HTTP APIs for clients like web/mobile app - **Test Mode:** Keploy reads the YAML files for test cases and stubs/mocks. It starts the application, sends recorded HTTP test cases, and mocks responses for outgoing calls. This ensures no side effects due to non-idempotency. Hope this helps you out, if you still have any questions, reach out to us . + +## Related + +- [What is Keploy?](/docs/keploy-explained/introduction/) — start-here overview. +- [Why Keploy?](/docs/keploy-explained/why-keploy/) — the problems it solves. +- [How Keploy Uses AI Models for Testing](/docs/keploy-explained/ai-models/) — the AI layer. diff --git a/versioned_docs/version-4.0.0/keploy-explained/integration-testing-faq.md b/versioned_docs/version-4.0.0/keploy-explained/integration-testing-faq.md index 10d5a739d..017592009 100644 --- a/versioned_docs/version-4.0.0/keploy-explained/integration-testing-faq.md +++ b/versioned_docs/version-4.0.0/keploy-explained/integration-testing-faq.md @@ -64,3 +64,9 @@ Yes, Keploy is open-source and free to use under the Apache 2.0 license. You can Yes, Keploy provides configuration options to customize recording, replay, and comparison logic for specific APIs, giving users control over how their APIs are tested. Hope this helps you out, if you still have any questions, reach out to us . + +## Related + +- [API Testing – Frequently Asked Questions](/docs/keploy-explained/api-testing-faq/) — API testing FAQ. +- [Unit Testing FAQ](/docs/keploy-explained/unit-testing-faq/) — unit testing FAQ. +- [How Keploy Works?](/docs/keploy-explained/how-keploy-works/) — how integration tests are captured. diff --git a/versioned_docs/version-4.0.0/keploy-explained/integrations-vscode.md b/versioned_docs/version-4.0.0/keploy-explained/integrations-vscode.md index 6026aaacc..ae5cba93e 100644 --- a/versioned_docs/version-4.0.0/keploy-explained/integrations-vscode.md +++ b/versioned_docs/version-4.0.0/keploy-explained/integrations-vscode.md @@ -16,7 +16,7 @@ Keploy aims to make AI-powered unit testing as seamless as possible—right insi ## ✅ Currently Supported **Visual Studio Code (VS Code):** - We offer smooth integration with VS Code, so you can generate, view, and manage AI-generated unit tests without leaving your IDE. +We offer smooth integration with VS Code, so you can generate, view, and manage AI-generated unit tests without leaving your IDE. ## 💡 Want Support for Another IDE? @@ -27,3 +27,9 @@ Need Keploy in JetBrains, Neovim, or another editor? Your feedback shapes our roadmap! More IDE integrations are coming soon—stay tuned. + +## Related + +- [SCM Integrations — PR Agent](/docs/keploy-explained/integrations-pr-agent/) — the pull-request integration. +- [Keploy Troubleshooting Guide](/docs/keploy-explained/common-errors/) — fix common setup issues. +- [What is Keploy?](/docs/keploy-explained/introduction/) — project overview. diff --git a/versioned_docs/version-4.0.0/keploy-explained/introduction.md b/versioned_docs/version-4.0.0/keploy-explained/introduction.md index 832fb0a1c..a3ccd72d7 100644 --- a/versioned_docs/version-4.0.0/keploy-explained/introduction.md +++ b/versioned_docs/version-4.0.0/keploy-explained/introduction.md @@ -12,3 +12,9 @@ import WhatIsKeploy from '../concepts/what-is-keploy.md' import WhatAreKeployFeatures from '../concepts/what-are-keploy-features.md' + +## Related + +- [Why Keploy?](/docs/keploy-explained/why-keploy/) — the motivation and benefits. +- [How Keploy Works?](/docs/keploy-explained/how-keploy-works/) — the underlying mechanism. +- [Supported Languages for Unit Testing](/docs/keploy-explained/supported-languages/) — language coverage. diff --git a/versioned_docs/version-4.0.0/keploy-explained/keploy-privacy.md b/versioned_docs/version-4.0.0/keploy-explained/keploy-privacy.md index 119ef9554..b9eb2b1ca 100644 --- a/versioned_docs/version-4.0.0/keploy-explained/keploy-privacy.md +++ b/versioned_docs/version-4.0.0/keploy-explained/keploy-privacy.md @@ -31,3 +31,9 @@ Keploy is built with privacy as a core value. Here’s how we keep your code and We’re committed to making privacy non-negotiable. Have questions, concerns, or requests? [Contact our team](mailto:support@keploy.io)—we’re here to help. + +## Related + +- [Security & Compliance at Keploy](/docs/keploy-explained/keploy-security/) — the security counterpart. +- [What is Keploy?](/docs/keploy-explained/introduction/) — project overview. +- [Why Keploy?](/docs/keploy-explained/why-keploy/) — where privacy fits in. diff --git a/versioned_docs/version-4.0.0/keploy-explained/keploy-security.md b/versioned_docs/version-4.0.0/keploy-explained/keploy-security.md index 88f233c2c..2566bdf21 100644 --- a/versioned_docs/version-4.0.0/keploy-explained/keploy-security.md +++ b/versioned_docs/version-4.0.0/keploy-explained/keploy-security.md @@ -38,3 +38,9 @@ Your data remains confidential and secure—whether you’re a startup or an ent - **Full Transparency:** We are open about our processes and happy to answer any questions you have about security or privacy. Have questions or need a security report for your team? [Contact us!](mailto:support@keploy.io) + +## Related + +- [Code Privacy & Data Protection](/docs/keploy-explained/keploy-privacy/) — the privacy counterpart. +- [What is Keploy?](/docs/keploy-explained/introduction/) — project overview. +- [How Keploy Works?](/docs/keploy-explained/how-keploy-works/) — where data is processed. diff --git a/versioned_docs/version-4.0.0/keploy-explained/mac-linux.md b/versioned_docs/version-4.0.0/keploy-explained/mac-linux.md index 42ef246f7..4c9436dfd 100644 --- a/versioned_docs/version-4.0.0/keploy-explained/mac-linux.md +++ b/versioned_docs/version-4.0.0/keploy-explained/mac-linux.md @@ -62,3 +62,9 @@ Congratulations! You've successfully set up Keploy natively on MacOS. Begin recording your API calls and generating test cases with Keploy. #### [Back to Installation Guide](/docs/server/installation/) + +## Related + +- [Running Keploy Natively on Windows](/docs/keploy-explained/windows-wsl/) — the Windows setup. +- [Keploy Troubleshooting Guide](/docs/keploy-explained/common-errors/) — fix common install issues. +- [Keploy CLI Commands](/docs/running-keploy/cli-commands/) — commands to run after install. diff --git a/versioned_docs/version-4.0.0/keploy-explained/supported-languages.md b/versioned_docs/version-4.0.0/keploy-explained/supported-languages.md index fd385be1b..abbe7bc79 100644 --- a/versioned_docs/version-4.0.0/keploy-explained/supported-languages.md +++ b/versioned_docs/version-4.0.0/keploy-explained/supported-languages.md @@ -49,3 +49,9 @@ We’re expanding—tell us what language you need next! **Our Promise:** No matter the language, Keploy helps you create _meaningful_, _maintainable_ tests that genuinely improve your code—not just sample outputs. + +## Related + +- [What is Keploy?](/docs/keploy-explained/introduction/) — project overview. +- [Best practices for unit testing and UTG?](/docs/keploy-explained/utg-best-practices/) — get the most per language. +- [Testing Guide](/docs/keploy-explained/testing-guide/) — testing concepts and workflow. diff --git a/versioned_docs/version-4.0.0/keploy-explained/testing-guide.md b/versioned_docs/version-4.0.0/keploy-explained/testing-guide.md index 93cb587d8..6bee3f6ee 100644 --- a/versioned_docs/version-4.0.0/keploy-explained/testing-guide.md +++ b/versioned_docs/version-4.0.0/keploy-explained/testing-guide.md @@ -145,3 +145,9 @@ If both scenarios yield a "passed" result, it signifies that this approach mirro Hope this helps you out, if you still have any questions, reach out to us . + +## Related + +- [What is Keploy?](/docs/keploy-explained/introduction/) — project overview. +- [Best practices for unit testing and UTG?](/docs/keploy-explained/utg-best-practices/) — practical guidance. +- [Supported Languages for Unit Testing](/docs/keploy-explained/supported-languages/) — language coverage. diff --git a/versioned_docs/version-4.0.0/keploy-explained/unit-testing-faq.md b/versioned_docs/version-4.0.0/keploy-explained/unit-testing-faq.md index 3b1df8de2..c39885d1c 100644 --- a/versioned_docs/version-4.0.0/keploy-explained/unit-testing-faq.md +++ b/versioned_docs/version-4.0.0/keploy-explained/unit-testing-faq.md @@ -103,3 +103,9 @@ We’re committed to keeping your trust. - Deeper IDE and CI/CD integrations Hope this helps you out, if you still have any questions, reach out to us . + +## Related + +- [Integration Testing FAQ](/docs/keploy-explained/integration-testing-faq/) — integration testing FAQ. +- [API Testing – Frequently Asked Questions](/docs/keploy-explained/api-testing-faq/) — API testing FAQ. +- [Best practices for unit testing and UTG?](/docs/keploy-explained/utg-best-practices/) — unit testing tips. diff --git a/versioned_docs/version-4.0.0/keploy-explained/utg-best-practices.md b/versioned_docs/version-4.0.0/keploy-explained/utg-best-practices.md index 2af7dfe78..b41b67c7e 100644 --- a/versioned_docs/version-4.0.0/keploy-explained/utg-best-practices.md +++ b/versioned_docs/version-4.0.0/keploy-explained/utg-best-practices.md @@ -278,3 +278,9 @@ Seamlessly blend test generation with existing development practices: - **Continuous Learning**: Stay updated with testing industry best practices _Remember: Automated testing tools are force multipliers, not replacements for thoughtful testing strategy. The goal is to amplify human expertise, not replace human judgment._ + +## Related + +- [Supported Languages for Unit Testing](/docs/keploy-explained/supported-languages/) — language coverage. +- [Testing Guide](/docs/keploy-explained/testing-guide/) — broader testing workflow. +- [Unit Testing FAQ](/docs/keploy-explained/unit-testing-faq/) — common unit testing questions. diff --git a/versioned_docs/version-4.0.0/keploy-explained/why-keploy.md b/versioned_docs/version-4.0.0/keploy-explained/why-keploy.md index 7e3f3495a..ab2745aa6 100644 --- a/versioned_docs/version-4.0.0/keploy-explained/why-keploy.md +++ b/versioned_docs/version-4.0.0/keploy-explained/why-keploy.md @@ -30,3 +30,9 @@ tags: ⭐ If you're excited about what's coming, show some love by [starring Keploy on GitHub](https://github.com/keploy/keploy) 🤙 We're happy to hear from you in-case you want to deep-dive. [Schedule a demo](https://calendar.app.google/3mHeyaoKg3A2qkqF6) – because the best tests are yet to come! 🚀🎉 + +## Related + +- [What is Keploy?](/docs/keploy-explained/introduction/) — project overview. +- [How Keploy Works?](/docs/keploy-explained/how-keploy-works/) — the mechanism behind the benefits. +- [Security & Compliance at Keploy](/docs/keploy-explained/keploy-security/) — enterprise readiness. From cf53f7fd9f18bdebebf70fbdd5747ed579cf3ca9 Mon Sep 17 00:00:00 2001 From: dhananjay6561 Date: Mon, 10 Aug 2026 19:10:13 +0530 Subject: [PATCH 21/26] docs(A4): add "Related" cross-links to ci-cd docs Cross-link the GitHub, GitLab and Jenkins CI guides to each other and to the API-test CI/CD setup. Build-verified routes. Signed-off-by: dhananjay6561 --- versioned_docs/version-4.0.0/ci-cd/github.md | 6 ++++++ versioned_docs/version-4.0.0/ci-cd/gitlab.md | 6 ++++++ versioned_docs/version-4.0.0/ci-cd/jenkins.md | 6 ++++++ 3 files changed, 18 insertions(+) diff --git a/versioned_docs/version-4.0.0/ci-cd/github.md b/versioned_docs/version-4.0.0/ci-cd/github.md index 94b2d6f37..939161423 100644 --- a/versioned_docs/version-4.0.0/ci-cd/github.md +++ b/versioned_docs/version-4.0.0/ci-cd/github.md @@ -274,3 +274,9 @@ Replace ``, ``, ``, and `` with your own > `KEPLOY_API_KEY: ${{ secrets.KEPLOY_API_KEY }}` pulls the value from GitHub's secret store and makes it available as an environment variable in all subsequent steps. Hope this helps you out, if you still have any questions, reach out to us . + +## Related + +- [Integrating with GitLab CI](/docs/ci-cd/gitlab/) — the GitLab equivalent. +- [Integrating with Jenkins](/docs/ci-cd/jenkins/) — the Jenkins equivalent. +- [API Test Setup for GitHub CI/CD](/docs/running-keploy/api-testing-cicd/) — API-suite CI setup. diff --git a/versioned_docs/version-4.0.0/ci-cd/gitlab.md b/versioned_docs/version-4.0.0/ci-cd/gitlab.md index 77433904a..3da68c7f5 100644 --- a/versioned_docs/version-4.0.0/ci-cd/gitlab.md +++ b/versioned_docs/version-4.0.0/ci-cd/gitlab.md @@ -191,3 +191,9 @@ keploy-cloud-replay: Replace ``, ``, ``, and `` with your own values. Set `` to cover your application's startup time (in seconds). > Because `KEPLOY_API_KEY` is defined as a masked variable in GitLab, it is already present in the job's environment — no `export` step is needed. + +## Related + +- [Integrating with GitHub CI](/docs/ci-cd/github/) — the GitHub equivalent. +- [Integrating with Jenkins](/docs/ci-cd/jenkins/) — the Jenkins equivalent. +- [API Test Setup for GitHub CI/CD](/docs/running-keploy/api-testing-cicd/) — API-suite CI setup. diff --git a/versioned_docs/version-4.0.0/ci-cd/jenkins.md b/versioned_docs/version-4.0.0/ci-cd/jenkins.md index 4ff9bd996..d84a6374a 100644 --- a/versioned_docs/version-4.0.0/ci-cd/jenkins.md +++ b/versioned_docs/version-4.0.0/ci-cd/jenkins.md @@ -228,3 +228,9 @@ pipeline { Replace ``, ``, ``, and `` with your own values. Set `` to cover your application's startup time (in seconds). > `withCredentials` binds the Jenkins secret to `KEPLOY_API_KEY` only for the duration of that stage — the CLI picks it up automatically. + +## Related + +- [Integrating with GitHub CI](/docs/ci-cd/github/) — the GitHub equivalent. +- [Integrating with GitLab CI](/docs/ci-cd/gitlab/) — the GitLab equivalent. +- [API Test Setup for GitHub CI/CD](/docs/running-keploy/api-testing-cicd/) — API-suite CI setup. From 881f8324820334fd5bfcc7db57a9c112e102befe Mon Sep 17 00:00:00 2001 From: dhananjay6561 Date: Mon, 10 Aug 2026 19:10:13 +0530 Subject: [PATCH 22/26] docs(A4): add "Related" cross-links to server install + SDK docs Add a "Related" section to the install pages and language SDK pages, cross-linking the SDKs and install guides. Build-verified routes. Signed-off-by: dhananjay6561 --- versioned_docs/version-4.0.0/server/installation.md | 6 ++++++ versioned_docs/version-4.0.0/server/installation_tabs.md | 6 ++++++ versioned_docs/version-4.0.0/server/sdk-installation/go.md | 6 ++++++ .../version-4.0.0/server/sdk-installation/java.md | 6 ++++++ .../version-4.0.0/server/sdk-installation/javascript.md | 6 ++++++ .../version-4.0.0/server/sdk-installation/python.md | 6 ++++++ 6 files changed, 36 insertions(+) diff --git a/versioned_docs/version-4.0.0/server/installation.md b/versioned_docs/version-4.0.0/server/installation.md index bc9729dc4..3f4612046 100644 --- a/versioned_docs/version-4.0.0/server/installation.md +++ b/versioned_docs/version-4.0.0/server/installation.md @@ -86,3 +86,9 @@ keploy test -c "CMD_TO_RUN_APP" --delay 10 ``` Explore the [Test Coverage Generation Guide](https://keploy.io/docs/server/sdk-installation/go/) for seeing test-coverage with your unit testing library and [Keploy Running Guide](https://keploy.io/docs/running-keploy/configuration-file/) for additional options and tips on customizing your Keploy setup to perfection. + +## Related + +- [Installing Keploy](/docs/server/installation/) — the full install guide with OS tabs. +- [Keploy Go SDK — Install & Merge Test Coverage](/docs/server/sdk-installation/go/) — set up a language SDK. +- [Keploy CLI Commands](/docs/running-keploy/cli-commands/) — commands to run after installing. diff --git a/versioned_docs/version-4.0.0/server/installation_tabs.md b/versioned_docs/version-4.0.0/server/installation_tabs.md index 76b0c5ac3..4164519df 100644 --- a/versioned_docs/version-4.0.0/server/installation_tabs.md +++ b/versioned_docs/version-4.0.0/server/installation_tabs.md @@ -968,3 +968,9 @@ You’ve successfully set up **Keploy on Windows** using **Docker**. + +## Related + +- [Keploy Local Installation](/docs/server/install/) — the quick local install. +- [Keploy Go SDK — Install & Merge Test Coverage](/docs/server/sdk-installation/go/) — set up a language SDK. +- [Keploy CLI Commands](/docs/running-keploy/cli-commands/) — commands to run after installing. diff --git a/versioned_docs/version-4.0.0/server/sdk-installation/go.md b/versioned_docs/version-4.0.0/server/sdk-installation/go.md index 54879409b..89a52ec09 100644 --- a/versioned_docs/version-4.0.0/server/sdk-installation/go.md +++ b/versioned_docs/version-4.0.0/server/sdk-installation/go.md @@ -109,3 +109,9 @@ To get the coverage related information for merged coverage data : ```go go tool cover -func combined-coverage.txt ``` + +## Related + +- [Java Agent for Dynamic Deduplication](/docs/server/sdk-installation/java/) — the Java SDK. +- [Keploy JavaScript SDK — Install & Merge Test Coverage](/docs/server/sdk-installation/javascript/) — the JS SDK. +- [Keploy Python SDK — Install & Merge Test Coverage](/docs/server/sdk-installation/python/) — the Python SDK. diff --git a/versioned_docs/version-4.0.0/server/sdk-installation/java.md b/versioned_docs/version-4.0.0/server/sdk-installation/java.md index d7da4884f..5f5f7b7b8 100644 --- a/versioned_docs/version-4.0.0/server/sdk-installation/java.md +++ b/versioned_docs/version-4.0.0/server/sdk-installation/java.md @@ -128,3 +128,9 @@ ENV KEPLOY_JAVA_CLASS_DIRS=/app/classes ## CI Guidance CI should run replay/test mode against checked-in Keploy test fixtures. Do not record Java dedup fixtures in the pipeline unless you intentionally want to refresh them. + +## Related + +- [Keploy Go SDK — Install & Merge Test Coverage](/docs/server/sdk-installation/go/) — the Go SDK. +- [Keploy JavaScript SDK — Install & Merge Test Coverage](/docs/server/sdk-installation/javascript/) — the JS SDK. +- [Keploy Python SDK — Install & Merge Test Coverage](/docs/server/sdk-installation/python/) — the Python SDK. diff --git a/versioned_docs/version-4.0.0/server/sdk-installation/javascript.md b/versioned_docs/version-4.0.0/server/sdk-installation/javascript.md index 4e07aefba..a114ef7ad 100644 --- a/versioned_docs/version-4.0.0/server/sdk-installation/javascript.md +++ b/versioned_docs/version-4.0.0/server/sdk-installation/javascript.md @@ -96,3 +96,9 @@ To get coverage related information for merged coverage data, Run: ```bash npm run coverage:report ``` + +## Related + +- [Keploy Go SDK — Install & Merge Test Coverage](/docs/server/sdk-installation/go/) — the Go SDK. +- [Java Agent for Dynamic Deduplication](/docs/server/sdk-installation/java/) — the Java SDK. +- [Keploy Python SDK — Install & Merge Test Coverage](/docs/server/sdk-installation/python/) — the Python SDK. diff --git a/versioned_docs/version-4.0.0/server/sdk-installation/python.md b/versioned_docs/version-4.0.0/server/sdk-installation/python.md index 16b75c0f9..4d6553ce8 100644 --- a/versioned_docs/version-4.0.0/server/sdk-installation/python.md +++ b/versioned_docs/version-4.0.0/server/sdk-installation/python.md @@ -89,3 +89,9 @@ and if you want the coverage in an html file, you can run: ```bash coverage html ``` + +## Related + +- [Keploy Go SDK — Install & Merge Test Coverage](/docs/server/sdk-installation/go/) — the Go SDK. +- [Java Agent for Dynamic Deduplication](/docs/server/sdk-installation/java/) — the Java SDK. +- [Keploy JavaScript SDK — Install & Merge Test Coverage](/docs/server/sdk-installation/javascript/) — the JS SDK. From a66ad506beb835f2e27dcfdf4c8d35e183a5b756 Mon Sep 17 00:00:00 2001 From: dhananjay6561 Date: Mon, 10 Aug 2026 19:18:55 +0530 Subject: [PATCH 23/26] docs(AI4): add HowTo schema to CI/CD integration guides Emit schema.org HowTo JSON-LD (visible={false}, no visual change) on the GitHub, GitLab and Jenkins guides so AI engines can extract the install-and-run steps. Signed-off-by: dhananjay6561 --- versioned_docs/version-4.0.0/ci-cd/github.md | 16 ++++++++++++++++ versioned_docs/version-4.0.0/ci-cd/gitlab.md | 16 ++++++++++++++++ versioned_docs/version-4.0.0/ci-cd/jenkins.md | 15 +++++++++++++++ 3 files changed, 47 insertions(+) diff --git a/versioned_docs/version-4.0.0/ci-cd/github.md b/versioned_docs/version-4.0.0/ci-cd/github.md index 939161423..839007ebc 100644 --- a/versioned_docs/version-4.0.0/ci-cd/github.md +++ b/versioned_docs/version-4.0.0/ci-cd/github.md @@ -14,6 +14,22 @@ tags: - plugin --- +import HowTo from '@site/src/components/HowTo'; + +\" to replay the recorded suites."}, +{name: "Run cloud replay (optional)", text: "Authenticate with a Keploy API token and trigger cloud replay from the pipeline for hosted test sets."}, +]} +visible={false} +/> + import ProductTier from '@site/src/components/ProductTier'; diff --git a/versioned_docs/version-4.0.0/ci-cd/gitlab.md b/versioned_docs/version-4.0.0/ci-cd/gitlab.md index 3da68c7f5..7dec0ff98 100644 --- a/versioned_docs/version-4.0.0/ci-cd/gitlab.md +++ b/versioned_docs/version-4.0.0/ci-cd/gitlab.md @@ -14,6 +14,22 @@ tags: - plugin --- +import HowTo from '@site/src/components/HowTo'; + +\" to replay the recorded suites."}, +]} +visible={false} +/> + import ProductTier from '@site/src/components/ProductTier'; diff --git a/versioned_docs/version-4.0.0/ci-cd/jenkins.md b/versioned_docs/version-4.0.0/ci-cd/jenkins.md index d84a6374a..d7c892842 100644 --- a/versioned_docs/version-4.0.0/ci-cd/jenkins.md +++ b/versioned_docs/version-4.0.0/ci-cd/jenkins.md @@ -14,6 +14,21 @@ tags: - plugin --- +import HowTo from '@site/src/components/HowTo'; + +\" to replay the recorded suites."}, +]} +visible={false} +/> + import ProductTier from '@site/src/components/ProductTier'; From 668e9df17831c24a038bf253efe435d07455c242 Mon Sep 17 00:00:00 2001 From: dhananjay6561 Date: Mon, 10 Aug 2026 19:18:55 +0530 Subject: [PATCH 24/26] docs(AI4): add HowTo schema to language SDK install guides Emit HowTo JSON-LD (visible={false}) on the Go, Java, JavaScript and Python SDK pages covering agent setup and coverage merge steps. Signed-off-by: dhananjay6561 --- .../version-4.0.0/server/sdk-installation/go.md | 15 +++++++++++++++ .../version-4.0.0/server/sdk-installation/java.md | 15 +++++++++++++++ .../server/sdk-installation/javascript.md | 15 +++++++++++++++ .../server/sdk-installation/python.md | 15 +++++++++++++++ 4 files changed, 60 insertions(+) diff --git a/versioned_docs/version-4.0.0/server/sdk-installation/go.md b/versioned_docs/version-4.0.0/server/sdk-installation/go.md index 89a52ec09..f28a56b00 100644 --- a/versioned_docs/version-4.0.0/server/sdk-installation/go.md +++ b/versioned_docs/version-4.0.0/server/sdk-installation/go.md @@ -19,6 +19,21 @@ keywords: - Go Test --- +import HowTo from '@site/src/components/HowTo'; + + + import ProductTier from '@site/src/components/ProductTier'; diff --git a/versioned_docs/version-4.0.0/server/sdk-installation/java.md b/versioned_docs/version-4.0.0/server/sdk-installation/java.md index 5f5f7b7b8..2fdc251af 100644 --- a/versioned_docs/version-4.0.0/server/sdk-installation/java.md +++ b/versioned_docs/version-4.0.0/server/sdk-installation/java.md @@ -16,6 +16,21 @@ keywords: - dynamic deduplication --- +import HowTo from '@site/src/components/HowTo'; + + + import ProductTier from '@site/src/components/ProductTier'; diff --git a/versioned_docs/version-4.0.0/server/sdk-installation/javascript.md b/versioned_docs/version-4.0.0/server/sdk-installation/javascript.md index a114ef7ad..8149b7f27 100644 --- a/versioned_docs/version-4.0.0/server/sdk-installation/javascript.md +++ b/versioned_docs/version-4.0.0/server/sdk-installation/javascript.md @@ -22,6 +22,21 @@ keywords: - Typescript --- +import HowTo from '@site/src/components/HowTo'; + + + import ProductTier from '@site/src/components/ProductTier'; diff --git a/versioned_docs/version-4.0.0/server/sdk-installation/python.md b/versioned_docs/version-4.0.0/server/sdk-installation/python.md index 4d6553ce8..21e16de85 100644 --- a/versioned_docs/version-4.0.0/server/sdk-installation/python.md +++ b/versioned_docs/version-4.0.0/server/sdk-installation/python.md @@ -17,6 +17,21 @@ keywords: - Pytest --- +import HowTo from '@site/src/components/HowTo'; + +\" to replay tests and generate coverage data."}, +{name: "Combine the report", text: "Combine the coverage data into a single report to view total covered lines."}, +]} +visible={false} +/> + import ProductTier from '@site/src/components/ProductTier'; From 78440b989d752966e757fd54c25c6acf8ee3489b Mon Sep 17 00:00:00 2001 From: dhananjay6561 Date: Mon, 10 Aug 2026 19:18:55 +0530 Subject: [PATCH 25/26] docs(AI4): add HowTo schema to Linux/Windows install guides Emit HowTo JSON-LD (visible={false}) on the Linux, Windows and native Windows/WSL install pages. Signed-off-by: dhananjay6561 --- .../keploy-explained/windows-wsl.md | 16 ++++++++++++++++ .../version-4.0.0/server/linux/installation.md | 15 +++++++++++++++ .../version-4.0.0/server/windows/installation.md | 15 +++++++++++++++ 3 files changed, 46 insertions(+) diff --git a/versioned_docs/version-4.0.0/keploy-explained/windows-wsl.md b/versioned_docs/version-4.0.0/keploy-explained/windows-wsl.md index f1f309d07..0dddd109a 100644 --- a/versioned_docs/version-4.0.0/keploy-explained/windows-wsl.md +++ b/versioned_docs/version-4.0.0/keploy-explained/windows-wsl.md @@ -15,6 +15,22 @@ keywords: - installation --- +import HowTo from '@site/src/components/HowTo'; + + + Keploy relies on the Linux kernel's eBPF subsystem to capture network traffic, so it does not run directly on the Windows kernel. On Windows you run Keploy inside **WSL (Windows Subsystem for Linux)**, which gives you a real Linux kernel while keeping your Windows development environment. This page covers the WSL prerequisites and installs the Keploy binary inside that Linux environment. ## Prerequisites diff --git a/versioned_docs/version-4.0.0/server/linux/installation.md b/versioned_docs/version-4.0.0/server/linux/installation.md index 13ff68f7e..1c20a6b1a 100644 --- a/versioned_docs/version-4.0.0/server/linux/installation.md +++ b/versioned_docs/version-4.0.0/server/linux/installation.md @@ -22,6 +22,21 @@ keywords: - server-setup --- +import HowTo from '@site/src/components/HowTo'; + + + Keploy can be installed in two ways: 1. [One-Click Install](#one-click-install-keploy). diff --git a/versioned_docs/version-4.0.0/server/windows/installation.md b/versioned_docs/version-4.0.0/server/windows/installation.md index 32db955b3..0e6e23878 100644 --- a/versioned_docs/version-4.0.0/server/windows/installation.md +++ b/versioned_docs/version-4.0.0/server/windows/installation.md @@ -21,6 +21,21 @@ keywords: - docker --- +import HowTo from '@site/src/components/HowTo'; + + + Keploy can be installed in two ways: 1. [One-Click Install](#one-click-install-keploy). From 409fbffa60a00e025b95845f0937e50ef2b0692e Mon Sep 17 00:00:00 2001 From: dhananjay6561 Date: Mon, 10 Aug 2026 19:46:16 +0530 Subject: [PATCH 26/26] ci(vale): accept technical terms flagged on changed lines Add gzip, Mux, Prisma, JWT, unbuggy, webhook, datastore, async, boolean, quickstarts and _Transform to the Vale accept vocabulary. These appear in the new "Related" link text and in prettier-normalized code lines, and are valid terms the Vale spell-check does not recognise. Signed-off-by: dhananjay6561 --- vale_styles/config/vocabularies/Base/accept.txt | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/vale_styles/config/vocabularies/Base/accept.txt b/vale_styles/config/vocabularies/Base/accept.txt index 898c9ad0a..f13dfac9a 100644 --- a/vale_styles/config/vocabularies/Base/accept.txt +++ b/vale_styles/config/vocabularies/Base/accept.txt @@ -227,3 +227,14 @@ cbshim stdin sudo [Rr]eplayable +[Aa]sync +[Bb]oolean +[Dd]atastore +[Gg]zip +[Jj][Ww][Tt] +[Mm]ux +[Pp]risma +[Qq]uickstarts? +[Uu]nbuggy +[Ww]ebhook('?s)? +_Transform