Skip to main content

Web API Verification without Coding.

Project description

Preacher: Web API Verification without Coding

PyPI version Documentation Status CircleCI Codecov Language grade: Python Code style: black

Preacher verifies API servers, which requests to the servers and verify the responses along to given scenarios.

Test scenarios are written only in YAML declaratively, without coding. In spite of that, Preacher can validate your web API flexibly, which enables you to test using real (neither mocks nor sandboxes) backends.

The full documentation is available at


  • Flexible validation to test with real backends: neither mocks nor sandboxes.
    • Matcher-based validation.
  • CI Friendly to automate easily.
    • A CLI application and YAML-based scenarios.


First, install Preacher.

The most basic way to install Preacher is using pip. Supports only Python 3.7+.

$ pip install preacher
$ preacher-cli --version

Instead of pip, Docker images are also available on Docker Hub as ymoch/preacher. By default, the container working directory is /work, and the host directory may be mounted here.

$ docker pull ymock/preacher
$ docker run -v $PWD:/work ymoch/preacher preacher-cli --version

Second, write your own scenario.

# scenario.yml
label: An example of a scenario
  - label: An example of a case
    request: /path/to/foo
      status_code: 200
        - describe: .foo
            equal: bar

Then, run preacher-cli command.

$ preacher-cli -u scenario.yml

For more information such as grammer of scenarios, see the full documentation.


MIT License

Copyright (c) 2019 Yu MOCHIZUKI

Project details

Download files

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

Source Distribution

preacher-0.15.11.tar.gz (44.2 kB view hashes)

Uploaded Source

Built Distribution

preacher-0.15.11-py3-none-any.whl (79.1 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