Automate API tests

Command: /api-aqa-flow · ← All scenarios · User guide

Turn API test cases and contracts into working, corrected, passing automated API tests in your repo.

Use this when you need backend API automation: working from API contracts, Swagger/OpenAPI specs, or request/response test cases, and implementing or fixing API tests.

Not for: UI/browser tests (Automate UI tests) or designing cases without code (Generate test cases).

Running it

/api-aqa-flow Automate API tests for the orders service
/api-aqa-flow Write API tests from these TestRail cases for the /payments endpoint
/api-aqa-flow Fix the failing API tests in the users module

How it works

It extracts the real endpoint contracts (from Swagger/OpenAPI or code), resolves gaps with you, writes Given-When-Then specs for your approval, implements them, and triages your execution results. Like the UI flow, it never assumes endpoints, payloads, auth, or response schemas.

flowchart TB
    Start(["/api-aqa-flow + test cases"]) --> Cfg{"Project config <br>exists?"}
    Cfg -->|no| Info["You provide project info"]
    Info --> Collect["Collect cases + docs"]
    Cfg -->|yes| Collect
    Collect --> Spec["Extract API contracts"]
    Spec --> G1{"You answer <br>clarifying questions"}
    G1 --> Cases["Write Given-When-Then specs"]
    Cases --> G2{"You approve <br>the specs"}
    G2 -->|request changes| Cases
    G2 -->|approve| Impl["Implement test files"]
    Impl --> Run["You run the tests <br>& share results"]
    Run --> Pass{"Tests pass?"}
    Pass -->|yes| Done(["Passing API tests"])
    Pass -->|no| Root["Analyze failures"]
    Root --> G3{"You approve <br>the fixes"}
    G3 -->|refine| Root
    G3 -->|approve| Impl

    classDef step fill:#dae8ff,stroke:#3674b5,color:#102a43;
    classDef gate fill:#fff2cc,stroke:#b58b00,color:#493800;
    classDef done fill:#e5f7e8,stroke:#35834a,color:#153b20;
    class Info,Collect,Spec,Cases,Impl,Run,Root step;
    class Cfg,G1,G2,Pass,G3 gate;
    class Start,Done done;

Every test spec (ATC-NNN) traces back to a source case or a documented gap, and your repository’s own conventions win over any generic defaults.

What you’ll be asked to do

Provide project info if there’s no config yet; answer clarifying questions; explicitly approve the test specs before implementation and the fixes before they’re applied; and run the tests yourself and share the real results (a “it passed” confirmation isn’t enough — the agent needs the actual output).

What it creates

A session folder plans/api-aqa-<identifier>/ with api-aqa-project-config.md, initial-data.md, raw-data.md, api-analysis.md, analysis.md, test-specs.md (the Given-When-Then cases), and execution-report.md; the implemented/corrected test files in your repo; and progress tracked in agents/TEMP/<feature>/api-aqa-state.md, which is not committed.

Automate UI tests for the frontend · Generate test cases to design cases first · unsure which? use the /aqa-flow router.

Prerequisites: Swagger/OpenAPI spec or backend source path.

Sources