Skip to main content

Adaptive API testing for OpenAPI and GraphQL

Project description

Build Coverage Version Python versions Discord License

Schemathesis

Catch API bugs before your users do.

Schemathesis tests OpenAPI and GraphQL APIs by generating inputs from your schema, adapting to server responses, and chaining operations into realistic workflows.

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.20.2.tar.gz (2.3 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.20.2-py3-none-any.whl (744.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for schemathesis-4.20.2.tar.gz
Algorithm Hash digest
SHA256 5d972df4de3074680c39338265fa54bf9f3331d17f55d998556abdaff6d43fbd
MD5 4e69d7eae861404cbe45b4db7be8f102
BLAKE2b-256 f27434dedfebf11eed5001422ed46c80b58e80f8ab9c9823d948f762188721e9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: schemathesis-4.20.2-py3-none-any.whl
  • Upload date:
  • Size: 744.1 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.20.2-py3-none-any.whl
Algorithm Hash digest
SHA256 43f310037fd600eb5077793651cfeebbb38fc1aee7a41635eca7867daae1796d
MD5 c8e2c5b1a86a85877304a1e7e0d00ee3
BLAKE2b-256 4f40ae635ff746c8b4dbdb7985880f8e4845bf4b06e52950985dc934a612f05d

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