Schemathesis: Property-based testing for API schemas๏ƒ

Schemathesis is a specification-centric API testing tool for Open API and GraphQL-based applications.

It reads the application schema and generates test cases, which will ensure that your application is compliant with its schema and never crashes.

The application under test could be written in any language; the only thing you need is a valid API schema in a supported format.

Simple to use and yet powerful to uncover hard-to-find errors thanks to the property-based testing approach backed by state-of-the-art Hypothesis library.

You can use Schemathesis in the command line directly:

st run https://example.schemathesis.io/openapi.json

Or via Docker:

docker run schemathesis/schemathesis:stable run https://example.schemathesis.io/openapi.json

Or in your Python tests:

import schemathesis

schema = schemathesis.from_uri("https://example.schemathesis.io/openapi.json")


@schema.parametrize()
def test_api(case):
    case.call_and_validate()

Both examples above will run hundreds of requests against the API under test and report all found failures and inconsistencies along with instructions to reproduce them.

Note

You can also use our SaaS to run more comprehensive tests and visualise the outcomes!

Features๏ƒ

  • Open API: Schema conformance, explicit examples, stateful testing;

  • GraphQL: queries generation;

  • Multi-worker test execution;

  • Storing and replaying tests;

  • ASGI / WSGI support;

  • Generated code samples (cURL, Python);

  • Docker image;

  • Customizable checks & test generation

Note

๐ŸŽ‰ Join our Discord, weโ€™d love to hear your feedback ๐ŸŽ‰

Userโ€™s Guide๏ƒ

Support๏ƒ

If you want to integrate Schemathesis into your company workflows or improve its effectiveness, feel free to reach out to support@schemathesis.io.

Schemathesis.io also runs workshops about effective API testing. Signup here

Resources๏ƒ

Additional notes๏ƒ