index.md

Dredd — HTTP API Testing Framework

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.

Supported API Description Formats

• API Blueprint
• Swagger

Supported Hooks Languages

Dredd supports writing hooks — a glue code for each test setup and teardown. Following languages are supported:

• Go

• Node.js (JavaScript)

• Perl

• PHP

• Travis CI

• CircleCI

• Jenkins

• ...and any other *nix based CI!

Contents

• Installation
• Quickstart
• How It Works
• How-To Guides
• Usage: CLI
• Usage: JavaScript
• About Hooks
• Hooks: Go
• Hooks: JavaScript (Sandboxed)
• Hooks: Node.js
• Hooks: Perl
• Hooks: PHP
• Hooks: Python
• Hooks: Ruby
• Other Languages
• Data Structures
• Contributing

Useful Links

• GitHub Repository
• Bug Tracker
• Changelog

Example Applications

• Express.js
• Ruby on Rails