API Watchdog

Usage

api-watchdog discover path/to/test/files

Will output the abbreviated result of the tests to stdout.

Installation

API watchdog handles validation support through extra requirements. This means that to install it with TRAPI validation you invoke

pip install api-watchdog[TRAPI]

If you are using zsh you will run affoul of bracket globbing and should use

pip install 'api-watchdog[TRAPI]'

See this stackoverflow question for context.

Available extensions are:

• TRAPI

If you do not want any validation support you can use the bare pip install api-watchdog command.

What it is

An API monitoring utility that aspires to support:

• Validation
• Continuous Integration
• Multiple input and output formats
• Test discovery / minimal configuration

What it is not

• A way to regularly schedule tests against an endpoint, eg. cron, celery
• A way to specify api schemas eg. marshmallow, pydantic