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.
Features
Supported API Description Formats
- `API Blueprint`_
- `OpenAPI 2`_ (formerly known as Swagger)
- `OpenAPI 3`_ (experimental, contributions welcome!)
Supported Hooks Languages
Dredd supports writing :ref:`hooks <hooks>` — a glue code for each test setup and teardown. Following languages are supported:
- :ref:`Go <hooks-go>`
- :ref:`Node.js (JavaScript) <hooks-nodejs>`
- :ref:`Perl <hooks-perl>`
- :ref:`PHP <hooks-php>`
- :ref:`Python <hooks-python>`
- :ref:`Ruby <hooks-ruby>`
- :ref:`Rust <hooks-rust>`
- Didn’t find your favorite language? :ref:`Add a new one! <hooks-new-language>`
Supported Systems
- Linux, macOS, Windows, …
- `Travis CI`_, `CircleCI`_, `Jenkins`_, `AppVeyor`_, …
Contents
.. toctree:: :maxdepth: 2 installation quickstart how-it-works how-to-guides Usage <usage-cli> JavaScript API <usage-js> Hooks <hooks/index> data-structures internals