Git Product home page Git Product logo

dredd's Introduction

Dredd — HTTP API Testing Framework

Build Status Dependency Status devDependency Status Coverage Status Join the chat at https://gitter.im/apiaryio/dredd

Dredd - HTTP API Testing Framework

Dredd is a language-agnostic command-line tool for validating API documentation written in API Blueprint format against its backend implementation.

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 Hook Languages

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

Continuous Integration Support

Installation

$ npm install -g dredd

Quick Start

  1. Create an API Blueprint file called api-description.apib. Follow tutorial at API Blueprint website or just take one of the ready-made examples.

  2. Run interactive configuration:

    $ dredd init
  3. Run Dredd:

    $ dredd
  4. To see how to use all Dredd's features, browse the full documentation.

dredd's People

Contributors

kuba-kubula avatar honzajavorek avatar w-vi avatar abtris avatar nweber avatar ddelnano avatar miiila avatar smizell avatar kylef avatar zdne avatar ungrim97 avatar jonathanbp avatar codefred avatar arcz avatar xvalentino avatar frio avatar bootstraponline avatar theodorton avatar gitter-badger avatar ngmarmaduke avatar snikch avatar michaelhirn avatar ksarna avatar jason-rayles-nbcuni avatar nevir avatar eddieroger avatar shieldo avatar d0ugal avatar colinrymer avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.