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.24.3.tar.gz (2.4 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.24.3-py3-none-any.whl (837.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for schemathesis-4.24.3.tar.gz
Algorithm Hash digest
SHA256 11b47ca77067ffeaa1400d33f216d214417dcb90fdbabed482a7238600366cb8
MD5 118cf6b7c47370d07d6e5dda9ae3753d
BLAKE2b-256 7bc9c41cdbf1e3d41440802c272f1b01dbe0d72939834a4b04cd8b306141ac50

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for schemathesis-4.24.3-py3-none-any.whl
Algorithm Hash digest
SHA256 c091fb8bb01898a373ecc5f2455cdf61e6882bfbb18d079c49b160f85eacbd88
MD5 b707331bce6a0f0c19e880d2d5ee1a71
BLAKE2b-256 78a356b5408e66d136644ff7212398544136e56e69cc2432911f44dff18a7322

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