pytest-api-coverage

Pytest plugin for API test coverage analysis. Automatically intercepts HTTP requests during test execution, compares them against OpenAPI specifications, and generates detailed coverage reports.

Features

• Automatic HTTP interception — captures requests from requests and httpx libraries
• Swagger/OpenAPI support — works with JSON and YAML specifications (local files or URLs)
• Multiple report formats — JSON, CSV, and HTML reports
• pytest-xdist support — works with parallel test execution
• Origin filtering — filter coverage by base URL or allowlist
• Split by origin — generate separate coverage per API origin
• Async support — intercepts both requests and httpx, including async httpx clients
• Multi-spec mode — measure coverage across multiple APIs in a single test run

Installation

Requires Python 3.11+ and pytest 7.0+.

# If your project uses requests
pip install pytest-api-coverage[requests]

# If your project uses httpx
pip install pytest-api-coverage[httpx]

# If your project uses both
pip install pytest-api-coverage[requests,httpx]

See Installation Guide for details.

Quick Start

# Basic usage with local spec file
pytest tests/ --coverage-spec=swagger.json

# Using remote spec URL
pytest tests/ --coverage-spec=https://api.example.com/swagger.json

# With parallel execution
pytest tests/ -n 4 --coverage-spec=swagger.json

Documentation

Contributing

Contributions are welcome. See CONTRIBUTING.md for development setup and guidelines.

License

MIT — see LICENSE for details.