Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/apiaryio/dredd

Language-agnostic HTTP API Testing Tool
https://github.com/apiaryio/dredd

api api-blueprint cli-app dredd http integration-testing openapi openapi-validation openapi2 openapi3 sjs-team swagger test-framework test-runner testing testing-framework tests unit-testing validation

Last synced: 17 days ago
JSON representation

Language-agnostic HTTP API Testing Tool

Host: GitHub
URL: https://github.com/apiaryio/dredd
Owner: apiaryio
License: mit
Archived: true
Created: 2013-09-04T12:21:35.000Z (over 11 years ago)
Default Branch: master
Last Pushed: 2024-05-11T13:19:25.000Z (7 months ago)
Last Synced: 2024-11-23T06:04:18.648Z (19 days ago)
Topics: api, api-blueprint, cli-app, dredd, http, integration-testing, openapi, openapi-validation, openapi2, openapi3, sjs-team, swagger, test-framework, test-runner, testing, testing-framework, tests, unit-testing, validation
Language: JavaScript
Homepage: https://dredd.org
Size: 7.27 MB
Stars: 4,192
Watchers: 74
Forks: 280
Open Issues: 260
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

awesome-api-clients - Dredd - Language-agnostic HTTP API Testing Tool (Automated Testing)
awesome - apiaryio/dredd - Language-agnostic HTTP API Testing Tool (testing)
awesome-python-testing - Dredd - is a language-agnostic command-line tool for validating API description document against backend implementation of the API. (Rest API Testing)
awesome-api-security - dredd - agnostic HTTP API Testing Tool | (Tools)
awesome-integration - Dredd (⭐4.1k) - Validate API description docs against backend implementation using this language-agnostic CLI tool. (Projects / API Design)
starred-awesome - dredd - Language-agnostic HTTP API Testing Framework (JavaScript)
awesome-hacking-lists - apiaryio/dredd - Language-agnostic HTTP API Testing Tool (JavaScript)
jimsghstars - apiaryio/dredd - Language-agnostic HTTP API Testing Tool (JavaScript)
best-of-web-python - GitHub - 31% open · ⏱️ 19.07.2023): (Web Testing)

README

        # Dredd — HTTP API Testing Framework

[![npm version](https://badge.fury.io/js/dredd.svg)](https://www.npmjs.com/package/dredd)

[![Build Status](https://circleci.com/gh/apiaryio/dredd/tree/master.svg?style=svg)](https://circleci.com/gh/apiaryio/dredd/tree/master)

[![Build Status](https://ci.appveyor.com/api/projects/status/n3ixfxh72qushyr4/branch/master?svg=true)](https://ci.appveyor.com/project/Apiary/dredd/branch/master)

[![Documentation Status](https://readthedocs.org/projects/dredd/badge/?version=latest)](https://readthedocs.org/projects/dredd/builds/)

[![Known Vulnerabilities](https://snyk.io/test/npm/dredd/badge.svg)](https://snyk.io/test/npm/dredd)

![Dredd - HTTP API Testing Framework](docs/_static/images/dredd.png?raw=true)

> **Dredd is a language-agnostic command-line tool for validating

> API 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 API

implementation replies with responses as they are described in the

documentation.

### Supported API Description Formats

- [API Blueprint][]

- [OpenAPI 2][] (formerly known as Swagger)

- [OpenAPI 3][] ([experimental](https://github.com/apiaryio/api-elements.js/blob/master/packages/openapi3-parser/STATUS.md), contributions welcome!)

### Supported Hooks Languages

Dredd supports writing [hooks](https://dredd.org/en/latest/hooks/)

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

- [Go](https://dredd.org/en/latest/hooks-go/)

- [Node.js (JavaScript)](https://dredd.org/en/latest/hooks-nodejs/)

- [Perl](https://dredd.org/en/latest/hooks-perl/)

- [PHP](https://dredd.org/en/latest/hooks-php/)

- [Python](https://dredd.org/en/latest/hooks-python/)

- [Ruby](https://dredd.org/en/latest/hooks-ruby/)

- [Rust](https://dredd.org/en/latest/hooks-rust/)

- Didn't find your favorite language? _[Add a new one!](https://dredd.org/en/latest/hooks-new-language/)_

### Supported Systems

- Linux, macOS, Windows, ...

- [Travis CI][], [CircleCI][], [Jenkins][], [AppVeyor][], ...

## Installation

```

$ npm install -g dredd

```

## Quick Start

1.  Create an [API Blueprint][] file called `api-description.apib`.

    Follow [tutorial at API Blueprint website][api blueprint tutorial]

    or just take one of the [ready-made examples][api blueprint examples].

2.  Run interactive configuration:

    ```shell

    $ dredd init

    ```

3.  Run Dredd:

    ```shell

    $ dredd

    ```

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

    [full documentation][documentation].

## Howtos, Tutorials, Blogposts (3rd party)

- [Maintenir à jour sa documentation d'API avec Dredd!](https://blog.itnetwork.fr/blog-post/2019/05/06/dredd-partie-1-ecriture-documentation.html) _05/06/2019_

- [Dredd - Language-agnostic HTTP API Testing Tool - Interview with Honza Javorek](https://survivejs.com/blog/dredd-interview/) _03/22/2019_

- [Laravel OpenAPI 3 Documentation Verification Using Dredd](https://commandz.io/snippets/laravel/laravel-dredd-openapi-v3/) _02/24/2019_

- [Testing your API with Dredd](https://medium.com/mop-developers/testing-your-api-with-dredd-c02e6ca151f2) _09/27/2018_

- [Writing Testable API Documentation Using APIB and Dredd (Rails)](https://blog.rebased.pl/2018/06/29/testable-api-docs.html) _06/29/2018_

- [Design-first API Specification Workflow Matures](https://philsturgeon.uk/api/2018/03/01/api-specification-workflow-matures/) _03/01/2018_

- [Writing and testing API specifications with API Blueprint, Dredd and Apiary](https://hackernoon.com/writing-and-testing-api-specifications-with-api-blueprint-dreed-and-apiary-df138accce5a) _12/04/2017_

- [Testing an API Against its Documentation](https://dev.to/albertofdzm/testing-an-api-against-documentation-6cl) _11/23/2017_

- [Keeping Documentation Honest](https://blog.apisyouwonthate.com/keeping-documentation-honest-d9ab5351ddd4) _11/21/2017_

- [Apiary designed APIs tested using Dredd](https://redthunder.blog/2017/09/20/apiary-designed-apis-tested-using-dredd/) _09/20/2017_

- [Dredd + Swagger for REST API testing](https://codeburst.io/dredd-swagger-for-rest-api-testing-715d1af5e8c5) _01/24/2017_

- [Testing Your API Documentation With Dredd](https://matthewdaly.co.uk/blog/2016/08/08/testing-your-api-documentation-with-dredd/) _08/08/2016_

- [DREDD API Tester works with API Blueprints](http://www.finklabs.org/articles/api-blueprint-dredd.html) _07/05/2016_

- [Documentation driven API Development using Laravel, Dredd and Apiary](https://medium.com/frianbiz/api-php-pilot%C3%A9e-par-la-doc-3c9eb4daa2aa) _06/21/2016_

- [Dredd v1.1.0: A Bit Different](https://philsturgeon.uk/api/2016/06/20/dredd-v1-1-0-a-bit-different/) _06/20/2016_

- [Dredd: Do Your HTTP API Justice](https://philsturgeon.uk/api/2015/01/28/dredd-api-testing-documentation/) _01/28/2015_

[api blueprint]: https://apiblueprint.org/

[api blueprint tutorial]: https://apiblueprint.org/documentation/tutorial.html

[api blueprint examples]: https://github.com/apiaryio/api-blueprint/tree/master/examples

[openapi 2]: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md

[openapi 3]: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md

[documentation]: https://dredd.org/en/latest/

[changelog]: https://github.com/apiaryio/dredd/releases

[contributor's guidelines]: https://dredd.org/en/latest/contributing/

[travis ci]: https://travis-ci.org/

[circleci]: https://circleci.com/

[jenkins]: https://jenkins.io/

[appveyor]: https://www.appveyor.com/