Dredd is a language-agnostic command-line tool for validating API description document against backend implementation of the API.
Dredd reads your API description and step by step validates whether your API implementation replies with responses as they are described in the documentation.
Dredd supports writing hooks — a glue code for each test setup and teardown. Following languages are supported:
- Go
- Node.js (JavaScript)
- Perl
- PHP
- Python
- Ruby
- Rust
- Didn't find your favorite language? Add a new one!
$ npm install -g dredd
-
Create an API Blueprint file called
api-description.apib. Follow tutorial at API Blueprint website or just take one of the ready-made examples. -
Run interactive configuration:
$ dredd init
-
Run Dredd:
$ dredd
-
To see how to use all Dredd's features, browse the full documentation.