Dredd is a language agnostic command-line tool for validating API documentation written in API Blueprint format against its backend implementation. With Dredd you can easily plug your API documentation into the Continous Integration system like Travis CI or Jenkins and have API documentation up-to-date, all the time. Dredd uses the Gavel for judging if a particular API response is valid or if it isn't. If you are curious about how decisions are made, please refer to Gavel's behavior specification.
Dredd supports writing hooks glue code for testing statefull servers, workflows and loading fixtures in:
You're welcome to write support for hooks in your language.
- If you don't have Node.js installed, you may want to use NVM
- Create an API blueprint in
blueprint.md - Install Dredd
$ npm install -g dredd
- Run interactive configuration:
$ dredd init
- Run dredd
$ dredd
Note: Dredd works smoothly with node.js 5.x.x, 4.x.x, 0.12.x, 0.10.x, and iojs v2.x.x.
View the full documentation for how to use all of Dredd's features.
Any contribution is more than welcome!
Let's start with creating your own virtual development environment,
then fork, write tests, write clean, readable code which communicate, use scripts/bdd, keep the test coverage and create a pull request. :)
Make sure to follow Dredd issues page.
To learn more about the future of API Blueprint & Testing visit apiaryio/api-blueprint#21.