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 Gitter 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.

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.

Features

  • Content-Type, schema, and status code conformance checks for Open API;

  • Testing of explicit examples from the input schema;

  • Stateful testing via Open API links;

  • Concurrent test execution;

  • Targeted testing;

  • Storing and replaying network requests;

  • Built-in ASGI / WSGI application support;

  • Ready-to-go Docker image;

  • Configurable with user-defined checks, string formats, hooks, and targets.

Installation

To install Schemathesis via pip run the following command:

pip install schemathesis

Usage

You can use Schemathesis in the command line:

schemathesis run --stateful=links --checks all http://0.0.0.0:8081/schema.yaml
https://github.com/schemathesis/schemathesis/blob/master/img/schemathesis.gif

Or in your Python tests:

import schemathesis

schema = schemathesis.from_uri("http://example.com/swagger.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.

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.

Please, help us to improve!

We’d kindly ask you to share your experience with Schemathesis. It will help me to make improvements to it and prioritize new features! It will take 5 minutes. The results are anonymous.

Survey: https://forms.gle/dv4s5SXAYWzvuwFWA

Support this project

Hi, my name is Dmitry! I started this project during my work at Kiwi.com. I am grateful to them for all the support they provided to this project during its early days and for the opportunity to evolve Schemathesis independently.

In order to grow the community of contributors and users, and allow me to devote more time to this project, please donate today.

Also, I occasionally write posts about Schemathesis in my blog and offer consulting services for businesses.

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

This version

2.6.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

schemathesis-2.6.0.tar.gz (80.5 kB view hashes)

Uploaded Source

Built Distribution

schemathesis-2.6.0-py3-none-any.whl (102.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page