APITestka Documentation

A lightweight, cross-platform framework for automated API testing. What started as an HTTP/HTTPS / SOAP-XML / JSON request runner now ships with variable chaining, OpenAPI / Postman / HAR / cURL importers, a record-replay proxy, security probes, parallel runners, an MCP server for Claude, and more.

Features

Category	Details
Backends	requests (sync, sessions), httpx (sync + async, HTTP/2), WebSocket, SSE, GraphQL
Data layer	Variable store, {{var}} templating, CSV/JSON data-driven loops, env profiles, fake data
Assertions	Field assertions, JSON Schema, JSONPath, snapshot, structural diffs, OpenAPI contract drift, response-time SLAs
Connection	mTLS, proxies, DNS override, VCR-style cassette record/replay
Mock server	Static, dynamic, stateful, fault injection, OpenAPI-driven, Jinja templating, webhook receiver, record-replay proxy
Runner	Sequential & parallel execution, tag filters, dependency-aware ordering, retry policies
Reports	HTML / JSON / XML / JUnit / Allure / Markdown / shields.io badge / SQLite trend store / run diff
Integrations	Slack / Teams / Discord webhook, GitHub PR comment, cURL & HAR importers, OpenAPI / Postman importer
CLI / DX	Subcommand CLI, REPL, terminal summary, shell completion, scaffold
Security	Auth helpers (Basic / Bearer / JWT / AWS SigV4), header / CORS / rate-limit / SSRF probes, pip-audit wrapper, fuzz inputs
Spec inference	Test record → OpenAPI, JSON Schema inference, OpenAPI changelog
AI	Pluggable backend with deterministic fallback for test generation, fake data, failure classification
MCP	First-class Claude Code / MCP server exposing the framework as tools
GUI	Optional PySide6 GUI (English / 繁中 / 简中 / 日本語) plus Swagger UI embed
Cross-Platform	Windows, macOS, Linux. Python 3.10–3.14

User Guide

• Installation
  • Install from PyPI
  • Install with GUI support
  • Requirements
  • Development Setup
• Quick Start
  • Using the requests Backend
  • Using the httpx Backend (Sync)
  • Using the httpx Backend (Async)
  • HTTP/2 Support
  • SOAP/XML Request
  • Session-Based Requests
• Getting Started
  • Create a Project
  • Run the Executor
  • Using Pure Python
• Extra Protocol Backends
  • WebSocket (optional)
  • Server-Sent Events
  • GraphQL
• Data Layer
  • VariableStore
  • Templating
  • Chaining requests
  • Data-driven tests
  • Fake data helpers
  • Environment profiles
  • Executor commands
• Result Assertion
  • Assertable Fields
• Response Diff, Contract & SLA
  • diff_payloads
  • OpenAPI contract drift
  • Response time SLA
  • Executor commands
• Connection Layer
  • ConnectionOptions
  • DNS override
  • VCR-style cassette
  • Executor commands
• Runner
  • Parallel runner
  • Tag filtering
  • Dependency-aware ordering
• Report Generation
  • HTML Report
  • JSON Report
  • XML Report
  • Using with Executor
• Mock Server
  • Basic Usage
  • Route with Method Detection
  • Custom Host and Port
• Callback Executor
  • Parameters
• Scripting with Executor
  • JSON Keyword-Driven Testing
  • Executing JSON Files via Python
  • Executing a Directory of JSON Files
  • Adding Custom Commands
  • Built-in Executor Commands
• CLI Usage
  • Commands
  • CLI Flags
• Integrations
  • Notifications
  • GitHub PR comment
  • cURL → action
  • HAR import
  • OpenAPI / Postman import
  • Executor commands
• Security Suite
  • Auth helpers
  • Header scan
  • CORS preflight
  • Rate-limit probe
  • SSRF probe
  • CVE scan
  • Fuzz seed
  • Executor commands
• Remote Automation (Socket Server)
  • Starting the Server
  • CLI Usage
• Project Scaffolding
  • Generated Structure
• Test Record
  • Record Fields
• MCP Server (Claude)
  • Installation
  • Running the server
  • Tools exposed
  • Claude Code configuration
  • Tool dispatch in code