Skip to main content

A web API verification tool.

Project description

Preacher: Web API Verification without Coding

PyPI version Documentation Status CircleCI Codecov Language grade: Python

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 preacher.readthedocs.io.

Targets

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

Usage

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
cases:
  - label: An example of a case
    request: /path/to/foo
    response:
      status_code: 200
      body:
        - describe: .foo
          should:
            equal: bar

Then, run preacher-cli command.

$ preacher-cli -u http://your.domain.com/base scenario.yml

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

License

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.

Files for preacher, version 0.14.1
Filename, size File type Python version Upload date Hashes
Filename, size preacher-0.14.1-py3-none-any.whl (46.4 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size preacher-0.14.1.tar.gz (28.6 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page