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.
Maintained fork#
This documentation belongs to the Stackly-maintained fork at stacklych/dredd. The original Apiary Dredd repository was archived upstream on November 8, 2024 and is now read-only. This fork keeps the original MIT license notice and continues development independently.
Features#
Supported API Description Formats#
Note
Dredd supports OpenAPI 3.0, 3.1, and 3.2 only. API Blueprint and OpenAPI 2 (Swagger) are no longer supported. Convert older descriptions to OpenAPI 3 before using Dredd.
OpenAPI 3 (3.0)
Both versions validate response status, structure, and data types against the described schemas — including $ref, allOf, arrays, nullable, and string formats.
Hooks#
Dredd supports writing hooks — glue code for test setup and teardown — in JavaScript, available out of the box.
Supported Systems#
Contents#
- Installation
- Quickstart
- How It Works
- How-To Guides
- Isolation of HTTP Transactions
- Testing API Workflows
- Making Dredd Validation Stricter
- Integrating Dredd with Your Test Suite
- Continuous Integration
- Authenticated APIs
- Sending Multipart Requests
- Sending Form Data
- Working with Images and other Binary Bodies
- Multiple Requests and Responses
- Removing Sensitive Data from Test Reports
- Usage
- JavaScript API
- Hooks
- Data Structures
- Internals