cucumber-api-tests-generator

Cucumber API Tests Generator

Generate TypeScript step definitions and API Client classes from Cucumber feature files for REST API testing.

Workflow Overview

1. Parse feature file → Extract API scenarios and steps
2. Analyze API operations → Identify endpoints, methods, request/response schemas
3. Check existing implementations → Avoid duplicates
4. Generate API Client class → Typed HTTP client with methods per endpoint
5. Generate step definitions → Given/When/Then with axios/supertest calls
6. Generate type models → Request/Response TypeScript interfaces

Step 1: Parse Feature File

Read the .feature file and extract API-specific information:

• Feature name and description
• Background steps (auth setup, base URL, etc.)
• All scenarios with steps
• HTTP methods (GET, POST, PUT, DELETE, PATCH)
• Endpoint paths (e.g., /api/v1/products)
• Request parameters (path, query, body, headers)
• Expected response status codes and body fields
• Data tables (request payload, expected fields)

// Example parsed API scenario
interface ParsedApiScenario {
  name: string;
  tags: string[];          // @smoke, @regression, @auth
  steps: Array<{
    keyword: 'Given' | 'When' | 'Then' | 'And';
    text: string;
    dataTable?: Record<string, string>[];
    docString?: string;    // JSON body as doc string
  }>;
}

Step 2: Analyze API Operations

Identify from the steps:

Pattern in step	Inference
"I send a GET request to {string}"	GET method, dynamic URL
"I call the {string} API with body:"	POST/PUT, has request body
"the response status should be {int}"	Status assertion
"the response should contain {string}"	Body field assertion
"I am authenticated as {string}"	Auth setup needed
"I set header {string} to {string}"	Custom request headers

Step 3: Check Existing Implementations

Scan project for existing API step files:

# Check existing step definitions
grep -r "Given\|When\|Then" src/step_definitions/api/*.ts 2>/dev/null || echo "No API steps found"

# Check existing API clients
ls src/support/api_clients/ 2>/dev/null || echo "No API clients found"