Repository files navigation

Dredd is a language-agnostic command-line tool for validatingAPI description document against backend implementation of the API.

• Documentation
• Changelog
• Contributor's Guidelines

Dredd reads your API description and step by step validates whether your APIimplementation replies with responses as they are described in thedocumentation.

• API Blueprint
• OpenAPI 2 (formerly known as Swagger)
• OpenAPI 3 (experimental, contributions welcome!)

Dredd supports writinghooks— 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!

• Linux, macOS, Windows, ...
• Travis CI,CircleCI,Jenkins,AppVeyor, ...

$ npm install -g dredd

1. Create anAPI Blueprint file calledapi-description.apib.Followtutorial at API Blueprint websiteor just take one of theready-made examples.

2. Run interactive configuration:

   $ dredd init

3. Run Dredd:

   $ dredd

4. To see how to use all Dredd's features, browse thefull documentation.

• Maintenir à jour sa documentation d'API avec Dredd!05/06/2019
• Dredd - Language-agnostic HTTP API Testing Tool - Interview with Honza Javorek03/22/2019
• Laravel OpenAPI 3 Documentation Verification Using Dredd02/24/2019
• Testing your API with Dredd09/27/2018
• Writing Testable API Documentation Using APIB and Dredd (Rails)06/29/2018
• Design-first API Specification Workflow Matures03/01/2018
• Writing and testing API specifications with API Blueprint, Dredd and Apiary12/04/2017
• Testing an API Against its Documentation11/23/2017
• Keeping Documentation Honest11/21/2017
• Apiary designed APIs tested using Dredd09/20/2017
• Dredd + Swagger for REST API testing01/24/2017
• Testing Your API Documentation With Dredd08/08/2016
• DREDD API Tester works with API Blueprints07/05/2016
• Documentation driven API Development using Laravel, Dredd and Apiary06/21/2016
• Dredd v1.1.0: A Bit Different06/20/2016
• Dredd: Do Your HTTP API Justice01/28/2015