Skip to main content

Introduction

danger

The Schemathesis SaaS platform will be sunset by end of March 2025. Future development will focus exclusively on the open source CLI.

Schemathesis is an API testing tool that automatically finds crashes and validates spec compliance.

Highlights​

  • 🎯 Catches Hard-to-Find Bugs: Automatically uncover crashes and spec violations that manual testing might miss.

  • ⚡ Accelerates Testing: Generate a wide range of test cases directly from your API schema.

  • 🧩 Integrates Seamlessly: Works with popular API formats such as OpenAPI and GraphQL, and easily integrates into your existing CI/CD workflows.

  • 🔧 Customizable and Extendable: Leverage Python extensions to configure and extend your test generation.

  • 🐞 Simplifies Debugging: Detailed reports and reproducible test cases with cURL commands streamline troubleshooting.

  • 🔬 Proven by Research: Validated through academic studies on API testing automation, featured in the ICSE 2022 paper on semantics-aware fuzzing, and recognized in an ACM survey as a state-of-the-art RESTful API testing tool.

Installation​

You can use Schemathesis via Docker or install it from PyPI:

# Via Docker
$ docker pull schemathesis/schemathesis:stable

# With pip
$ pip install schemathesis

Getting Started​

Run Schemathesis as a standalone CLI:

docker run schemathesis/schemathesis:stable run --checks all https://example.schemathesis.io/openapi.json
# Or when installed with pip:
schemathesis run --checks all https://example.schemathesis.io/openapi.json

Contributing​

Schemathesis is developed as an open source project. Contributions from the community help shape its future. Visit our GitHub repository for more details on how to contribute.