Skip to main content

Property-based testing framework for Open API and GraphQL based apps

Project description

Build Coverage Version Python versions Discord License

Schemathesis

Catch API bugs before your users do.

Schemathesis automatically generates thousands of test cases from your OpenAPI or GraphQL schema and finds edge cases that break your API.

Schemathesis automatically finding a server error
Finding bugs that manual testing missed

Try it now

# Test a demo API - finds real bugs in 30 seconds
uvx schemathesis run https://example.schemathesis.io/openapi.json

# Test your own API
uvx schemathesis run https://your-api.com/openapi.json

What problems does it solve?

  • 💥 500 errors that crash your API on edge case inputs
  • 📋 Schema violations where your API returns different data than documented
  • 🚪 Validation bypasses where invalid data gets accepted
  • 🔗 Integration failures when responses don't match client expectations
  • 🔄 Stateful bugs where operations work individually but fail in realistic workflows

⚠️ Upgrading from older versions? Check our Migration Guide for key changes.

Installation & Usage

Command Line:

uv pip install schemathesis
schemathesis run https://your-api.com/openapi.json

Python Tests:

import schemathesis

schema = schemathesis.openapi.from_url("https://your-api.com/openapi.json")

@schema.parametrize()
def test_api(case):
    # Tests with random data, edge cases, and invalid inputs
    case.call_and_validate()

# Stateful testing: Tests workflows like: create user -> get user -> delete user
APIWorkflow = schema.as_state_machine()
# Creates a test class for pytest/unittest
TestAPI = APIWorkflow.TestCase

CI/CD:

- uses: schemathesis/action@v3
  with:
    schema: "https://your-api.com/openapi.json"

Who uses it

Used by teams at Spotify, WordPress, JetBrains, Red Hat, and dozens of other companies.

"Schemathesis is the best tool for fuzz testing of REST APIs on the market. We at Red Hat use it for examining our applications in functional and integration testing levels." - Dmitry Misharov, RedHat

See it in action

🔬 Live Benchmarks showing continuous testing results from real-world APIs:

  • Code & API schema coverage achieved
  • Issues found with detailed categorization
  • Performance across different fuzzing strategies

Reporting

  • Allure — Rich visual reports with per-operation results, failure steps, and curl reproduction commands
  • JUnit XML — For GitHub Actions, GitLab CI, Jenkins, and any CI tool that consumes JUnit

Documentation

📚 Documentation with guides, examples, and API reference.

Get Help

Contributing

We welcome contributions! See our contributing guidelines and join discussions in issues or Discord.

Acknowledgements

Schemathesis is built on top of Hypothesis, a powerful property-based testing library for Python.

License

This project is licensed under the terms of the MIT license.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

schemathesis-4.15.1.tar.gz (59.8 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

schemathesis-4.15.1-py3-none-any.whl (517.2 kB view details)

Uploaded Python 3

File details

Details for the file schemathesis-4.15.1.tar.gz.

File metadata

  • Download URL: schemathesis-4.15.1.tar.gz
  • Upload date:
  • Size: 59.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for schemathesis-4.15.1.tar.gz
Algorithm Hash digest
SHA256 b7885836d77115a1a9cfd3b733edbe8858c89120e7baf496a131a409f425a2e7
MD5 158838201e0d09c1fe650fc0c5db5386
BLAKE2b-256 46ba62b8c92ef916d7af1dd412436319298f55fbce2534499bb8a4f71dda4a71

See more details on using hashes here.

File details

Details for the file schemathesis-4.15.1-py3-none-any.whl.

File metadata

  • Download URL: schemathesis-4.15.1-py3-none-any.whl
  • Upload date:
  • Size: 517.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for schemathesis-4.15.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f57d29b94fbd1eb16f1a3b591ceee3697f8f2c9b628da45e5a1e168a36320cdd
MD5 b68ea6f796834895614908415c1ceb4e
BLAKE2b-256 4c69488f5f322732d2a267345286311dfa5e3a41a4888c66f03e86d97c0546ca

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page