Skip to main content

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

Project description

Build codecov.io status for master branch Version Python versions Documentation Status Discord License

Schemathesis is a modern API testing tool for web applications built with Open API and GraphQL specifications.

It reads the application schema and generates test cases, which will ensure that your application is compliant with its schema (read more about how it works in our research paper).

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.

🚀 Schemathesis is available as a service, standalone CLI, or a Python library 🚀

The service enables you to verify your API schema in a few clicks, CLI gives more control. Schemathesis.io has a free tier, so you can combine the CLI flexibility with rich visuals by uploading your test results there.

Signup to reveal all issues on a dashboard.

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

CLI installation

To install Schemathesis via pip run the following command:

pip install schemathesis

This command installs the schemathesis entrypoint + st as its alias.

You can also use our Docker image without installing Schemathesis as a Python package.

Usage

You can use Schemathesis in the command line directly (st is an alias to schemathesis):

st run --checks all https://example.schemathesis.io/openapi.json

Or via Docker:

docker run schemathesis/schemathesis:stable \
    run --checks all https://example.schemathesis.io/openapi.json
https://raw.githubusercontent.com/schemathesis/schemathesis/master/img/schemathesis.gif

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()

CLI is simple to use and requires no coding; the in-code approach gives more flexibility.

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.

💡 See a complete working example project in the /example directory. 💡

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

Contributing

Any contribution to development, testing, or any other area is highly appreciated and useful to the project. For guidance on how to contribute to Schemathesis, see the contributing guidelines.

License

The code in this project is licensed under MIT license. By contributing to Schemathesis, you agree that your contributions will be licensed under its 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-3.15.6.tar.gz (153.9 kB view hashes)

Uploaded source

Built Distribution

schemathesis-3.15.6-py3-none-any.whl (188.0 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page