api-test-suite-builder

API Test Suite Builder

Scans API route definitions across frameworks (Next.js App Router, Express, FastAPI, Django REST) and generates a runnable test suite — Vitest+Supertest (Node) or Pytest+httpx (Python) — covering auth, input validation, error codes, pagination, file upload, and rate limiting.

Input Checklist

Input	Required	Description
Project root	Yes	Path to the repo containing the API route definitions
Framework	Yes	next-app-router / express / fastapi / django-rest (if unsure, step 1's probe commands decide it)
Test stack	Yes	vitest+supertest (Node) or pytest+httpx (Python)
Output location	No	The directory for test files; defaults to project convention (tests/ or __tests__/)
Generation scope	No	All routes or a specified route group; defaults to all

When inputs are missing, ask for all at once: "Please provide: (1) the project root; (2) the test stack (Vitest+Supertest or Pytest+httpx); (3) whether to generate only some routes. If the framework is unclear, I'll decide it with probe commands first."

Pre-flight Checks

Run each in turn; on any failure → apply the fix, then STOP:

# 1. The project directory exists
ls <project-root> > /dev/null && echo OK
# Expected: OK. On failure → confirm the path with the user, STOP.

# 2. Probe for framework signals (at least one hits)
ls <project-root>/package.json <project-root>/requirements.txt <project-root>/pyproject.toml 2>/dev/null
# Expected: at least one file listed. If all are missing → confirm this is an API project, STOP.

# 3. The test runner is available
node --version || python3 --version
# Expected: prints a version. On failure → test-file generation is unaffected, but note to the user that local verification isn't possible.

Workflow

Step 1: Probe routes

Run the probe command for the corresponding framework (in the project root):

Next.js App Router

find ./app/api -name "route.ts" -o -name "route.js" | sort
grep -rn "export async function\|export function" app/api/**/route.ts | \
  grep -oE "(GET|POST|PUT|PATCH|DELETE|HEAD|OPTIONS)" | sort -u
find ./app/api -name "route.ts" | while read f; do
  route=$(echo $f | sed 's|./app||' | sed 's|/route.ts||')
  methods=$(grep -oE "export (async )?function (GET|POST|PUT|PATCH|DELETE)" "$f" | \
    grep -oE "(GET|POST|PUT|PATCH|DELETE)")
  echo "$methods $route"
done