Karate Feature Generator

Mapping User Story → Feature scenarios

Scenario order (always follow this order)

1. List all resources — GET /<domain>
2. Get single resource — GET /<domain>/{id}
3. Create resource — POST /<domain>
4. Full update — PUT /<domain>/{id}
5. Partial update — PATCH /<domain>/{id}
6. Delete — DELETE /<domain>/{id}
7. Error / edge cases (404, 400, 422)

Karate DSL rules — non-negotiable

ALLOWED matchers:
  '#number'     → any number
  '#string'     → any string
  '#boolean'    → any boolean
  '#null'       → null value
  '#notnull'    → not null
  '#ignore'     → skip this field
  '#array'      → any array
  '#[n]'        → array of exactly n items
  '#regex ...'  → regex match

FORBIDDEN in .feature files:
  × Hardcoded API keys
  × Java code or imports
  × Implementation details in step text
  × Raw assertEquals — always use 'match'
  × Business logic (calculations, conditions)
  × Comments in code (# inline comments, // or /* */ in Java) — self-documenting
    code is preferred; scenario names and tag names must be expressive enough

Background — always include

Background:
    * url baseUrl                                          # from karate-config.js
    * header Authorization = 'Bearer ' + apiKey           # if auth needed
    * def <domain>Model = { id: '#number', <field>: '#string', ... }

Schema definition pattern

Define the model schema in Background using fuzzy matchers. Reference it in assertions:

# Definition
* def petModel = { id: '#number', name: '#string', species: '#string', age: '#number' }

# Usage — validate list items
And match each response contains petModel

# Usage — validate single item
And match response contains petModel

Error scenario pattern

@error-path
Scenario: Get non-existent <domain> returns 404
    Given path '/<domain>/99999'
    When method get
    Then status 404

Data-driven pattern (Scenario Outline)

@edge-case
Scenario Outline: Create <domain> with invalid <field> returns 400
    * def request_body = { <field>: '<value>' }
    Given path '/<domain>'
    And request request_body
    When method post
    Then status 400

    Examples:
        | field  | value |
        | name   |       |
        | email  | notanemail |

SOLID principles applied to Karate

Clean Code checklist before creating

• Domain name is lowercase, singular noun (e.g. pet, order)
• File path follows examples/<domain>/<domain>.feature
• Runner package matches examples.<domain>
• Model schema covers all fields returned by the API
• Every scenario has a descriptive name in plain English
• No scenario exceeds 10 steps — split if needed
• Tags applied: @smoke for critical, @regression for full coverage
• Background has no steps that only one scenario needs