Skip to content

generate-api-tests-using-ai.md

Latest commit

 

History

History
80 lines (59 loc) · 5.53 KB

generate-api-tests-using-ai.md

File metadata and controls

80 lines (59 loc) · 5.53 KB
id generate-api-tests-using-ai
title Generate API Tests using AI
sidebar_label Generate API Tests
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.

import ProductTier from '@site/src/components/ProductTier';

This guide will help you generate automated API tests using Keploy's AI-based test engine by providing structured inputs like OpenAPI specs, curl commands, Postman collections, or live endpoints.

👉 If you want to record API flows by interacting with your web app through a browser, follow this guide instead: Record API Tests via Chrome Extension

Getting Started

  • Go to the Keploy Console
  • Upload your API input (schema, collection, or curl)
  • 👊 Hit Generate Tests and Keploy will parse your input, hit the API, and generate validated test flows with response-based assertions.
  • If private endpoints are detected, follow the agent setup prompt
  • Review and edit your generated tests

⚠️ Private Endpoint API Warning

If your API is not publicly accessible, Keploy will show a warning when attempting to reach those endpoints. To resolve this, install the Keploy Agent proxy locally

Keploy Agent Installation

Platform Steps
macOS - Download

- Open the .dmg file and install the app normally.

- Launch the Keploy Agent after installation.
Linux - Run the following in your terminal:

curl -L -O https://keploy-enterprise.s3.us-west-2.amazonaws.com/releases/latest/keploy-agent-linux-amd64.tar.gz

tar -xzf keploy-agent-linux-amd64.tar.gz

./keploy-agent

Windows - Download

Extract the zip file and Launch the Keploy Agent.

✅ Once installed and running, return to the Keploy Console and hit Generate API Tests. The agent will proxy your local API to allow secure test generation.

BEST Practices for BEST Test Output

Input Type Tips
OpenAPI Spec/Swagger Doc Use OpenAPI v3, best if links are also mentioned
Postman Collection Export the postman collection and copy the JSON to keploy console
curl Commands Provide 3-4 WORKING (2xx) cURL commands along with responses
Live Endpoint Only Ensure you're providing a valid and testable API base URL.

Valid & Invalid URL Examples

Use a base API path, not a homepage or static resource, for generating test flows.

URL Example Why It's Good or Bad
https://api.example.com ✅ API subdomain — general and testable
https://example.com/api ✅ API under path — works across many endpoints
https://example.com/api/v2 ✅ Versioned API route
https://example.com/v2/orders ✅ Specific API group — stable path
https://example.com ❌ Homepage — not an API
https://example.com/index.html ❌ Static file — not useful for API testing
https://api.example.com/orders/126789 ❌ Too specific — single object, not general

⚠️ Avoid using URLs pointing to static resources or deeply nested objects.

What Keploy Generates

Every test generated will include:

  • ✅ API request + actual response
  • ✅ Assertions on status, body, and headers
  • ✅ Multi-step flow generation (e.g. POST → GET → DELETE)
  • ✅ Automatic test deduplication
  • ✅ Environment reusability for staging, QA, or CI
  • ✅ Labeled, editable, and sharable from the dashboard