apiaryio/dredd

Stars
4,169
Rank 10,386 (Top 0.3 %)
Language
JavaScript
License
MIT License
Created over 11 years ago
Updated 7 months ago

apiaryio/dredd

apiaryio

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Language-agnostic HTTP API Testing Tool

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
OpenAPI 2 (formerly known as Swagger)
OpenAPI 3 (experimental, contributions welcome!)

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
Python
Ruby
Rust
Didn't find your favorite language? Add a new one!

Supported Systems

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

Installation

$ npm install -g dredd

Quick Start

Create an API Blueprint file called api-description.apib. Follow tutorial at API Blueprint website or just take one of the ready-made examples.
Run interactive configuration:
```
$ dredd init
```
Run Dredd:
```
$ dredd
```
To see how to use all Dredd's features, browse the full documentation.

Howtos, Tutorials, Blogposts (3rd party)

Maintenir à jour sa documentation d'API avec Dredd! 05/06/2019
Dredd - Language-agnostic HTTP API Testing Tool - Interview with Honza Javorek 03/22/2019
Laravel OpenAPI 3 Documentation Verification Using Dredd 02/24/2019
Testing your API with Dredd 09/27/2018
Writing Testable API Documentation Using APIB and Dredd (Rails) 06/29/2018
Design-first API Specification Workflow Matures 03/01/2018
Writing and testing API specifications with API Blueprint, Dredd and Apiary 12/04/2017
Testing an API Against its Documentation 11/23/2017
Keeping Documentation Honest 11/21/2017
Apiary designed APIs tested using Dredd 09/20/2017
Dredd + Swagger for REST API testing 01/24/2017
Testing Your API Documentation With Dredd 08/08/2016
DREDD API Tester works with API Blueprints 07/05/2016
Documentation driven API Development using Laravel, Dredd and Apiary 06/21/2016
Dredd v1.1.0: A Bit Different 06/20/2016
Dredd: Do Your HTTP API Justice 01/28/2015

api-blueprint

mson

Markdown Syntax for Object Notation

snowcrash

API Blueprint Parser

protagonist

Protagonist is Node.js wrapper for the API Blueprint parser

drafter

API Blueprint Parser (C++)

apiary-client

Apiary CLI client

curl-trace-parser

Parser for output from Curl --trace option

api-blueprint-sublime-plugin

API Blueprint Sublime Text plugin

s3-streaming-upload

s3-streaming-upload is node.js library that listens to your stream and upload its data to Amazon S3 using ManagedUpload API.

gavel-spec

Behavior specification for Gavel, validator of HTTP transactions

swagger2blueprint

Convert Swagger API descriptions into API Blueprint

gavel.js

Validator of HTTP messages (JavaScript implementation)

dredd-example

Example application using Dredd and CI

api-elements.js

Library for consuming API Elements in JavaScript

redsnow

Ruby binding for the Snow Crash library, also a thermonuclear weapon.

drafter.js

API Blueprint parser in JS

fury.js

API Description SDK

emscripten-docker

Emscripten as docker images

cloudwatch-to-papertrail

Lambda to send logs from Cloudwatch to Papertrail

blueprint-parser

Deprecated PEG.js-based parser for parsing legacy Apiary Blueprint Format

polls-api

Polls is an example web API that allows consumers to view polls and vote in them.

api-blueprint-rfcs

The API Blueprint RFC process

chrome-extension-ci

How to put a Chrome Extension into CI

attributes-kit

DEPRECATED Attributes Kit helps you with rendering MSON.

drafter-npm

Node API Blueprint Parser

language-templates

Language templates used to render example HTTP calls in different languages

polls-app

Swift iPhone and iPad Client for Polls API, using Hyperdrive API client

heroku-datadog-drain-golang

Funnel metrics from multiple Heroku apps into DataDog using statsd.

api-blueprint-ast

API Blueprint AST Serialization Media Types [adhd, apib]

Paw-APIBlueprintGenerator

Paw extension providing support to export API Blueprint as a code generator.

api-elements

API Elements is a structure for describing APIs and the complex data structures used within them.

http-string-parser

Parse HTTP Request and Response from String in Node.JS

apiblueprint.org

API Blueprint Website

apiblueprintorg

old apiblueprint.org site

dredd-hooks-python

Python Hooks for Dredd API Testing Framework

matter_compiler

API Blueprint AST to API Blueprint Conversion Tool [adhd]

api-blueprint-cheatsheet

API Blueprint Cheatsheet

apiaryio.github.com

dredd-hooks-ruby

Ruby Hooks Worker for Dredd API Testing Framework

fury-cli

Command line tool interface for Fury.js

fury-adapter-swagger

Swagger 2.0 parser adapter for Fury.js

dredd-transactions

Compiles a list of HTTP transactions (request-response pairs) from an API description document

markdown-parser

The real Markdown parser deal. You know, the one with a Markdown AST. Based on Upskirt, Sundown, Redcarpet or Hoedown whatever is trending.

ivy

A Node.js queue library focused on easy, yet flexible task execution.

Paw-APIBlueprintImporter

Paw extension to import API Blueprint

sos

Simple c++ Object Serialization

api.apiblueprint.org

docker-base-images

Base docker images for Apiary applications

constitutions

Write API Style Guide Rules locally, collaboratively and test them in CI

deckardcain

Deckard Cain library identifies (media) type of API description files

boutique.js

The finest representations to emphasize natural beauty of your MSON AST

protected-s3

Simple application that allows you to display the content of your S3 to authorised users only.

black-belt

Internal toolbelt on steroids (idle since September 2018)

mson-ast

MSON AST Serialization Media Types

dredd-hooks-template

Template of an integration test suite for writing Dredd hooks handler in a new language

dredd-docker

Docker image for Dredd, a language-agnostic HTTP API testing tool

mson-zoo

Collection of MSON samples that can be used as a showcase or testing purposes

base-styles

Apiary Base CSS Styles

fury-adapter-apib-serializer

API Blueprint serializer for Fury.js

dredd-test-rails

Example Rails application for testing with API Blueprint and Dredd

npm-boilerplate

Boilerplate for NPM package with Mocha, CoffeeScript and test directory structure

swagger-zoo

A collection of Swagger examples and their Refract representation

heroku-kafka-demo-nodejs

blueprint-transactions

Deprecated compiler of HTTP Transactions from API Blueprint AST

refract-query

generator-apiary-lib

Deprecated Apiary's Yeoman generator for basic library scaffolding

datapool

Library of miscellaneous reusable data models for API Blueprint

apiary_blueprint_convertor

Legacy Apiary Blueprint AST to API Blueprint AST convertor.

metamorphoses

Transforms API Blueprint AST or legacy Apiary Blueprint AST into Apiary Application AST

wercker-npm-install-test

pagerduty-overlap-checker

Pager Duty Overrides Checker

tully-test

api-blueprint-http-formatter

Format pair of HTTP Request and Response to API Blueprint format

abagnale

Forge unique IDs for Refract data structure elements

blueprint-markdown-renderer

Default parser and set of settings for parsing Markdown blocks in API Blueprint

misterio

Testing project to compare C++ parser generator for ability to parse blueprint

dribbble-api

example-intersphinx-repo

This repository demonstrates using Intersphinx with indexes being exported in Docker volume

console-proxy

Apiary Browser Console