Coder Social home page Coder Social logo

ungrim97 / dredd Goto Github PK

View Code? Open in Web Editor NEW

This project forked from apiaryio/dredd

0.0 2.0 0.0 1.18 MB

Language agnostic HTTP API Testing Framework

Home Page: http://dredd.rtfd.org/

License: MIT License

JavaScript 0.05% Shell 0.28% CoffeeScript 99.67%

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 API Blueprint testing tool

Dredd is a language agnostic command-line tool for validating API documentation written in API Blueprint format against its backend implementation. With Dredd you can easily plug your API documentation into the Continous Integration system like Travis CI or Jenkins and have API documentation up-to-date, all the time. Dredd uses the Gavel for judging if a particular API response is valid or if it isn't. If you are curious about how decisions are made, please refer to Gavel's behavior specification.

Dredd supports writing hooks glue code for testing statefull servers, workflows and loading fixtures in:

You're welcome to write support for hooks in your language.

Get Started Testing your API backend with your API Documentation

  • If you don't have Node.js installed, you may want to use NVM
  • Create an API blueprint in blueprint.md
  • Install Dredd
$ npm install -g dredd
  • Run interactive configuration:
$ dredd init
  • Run dredd
$ dredd

Note: Dredd works smoothly with node.js 5.x.x, 4.x.x, 0.12.x, 0.10.x, and iojs v2.x.x.

Documentation

View the full documentation for how to use all of Dredd's features.

Contribution

Any contribution is more than welcome! Let's start with creating your own virtual development environment, then fork, write tests, write clean, readable code which communicate, use scripts/bdd, keep the test coverage and create a pull request. :)

Make sure to follow Dredd issues page.

To learn more about the future of API Blueprint & Testing visit apiaryio/api-blueprint#21.

dredd's People

Contributors

abtris avatar arcz avatar bootstraponline avatar codefred avatar d0ugal avatar ddelnano avatar eddieroger avatar frio avatar gitter-badger avatar honzajavorek avatar jonathanbp avatar ksarna avatar kuba-kubula avatar kylef avatar michaelhirn avatar nevir avatar ngmarmaduke avatar shieldo avatar smizell avatar snikch avatar theodorton avatar w-vi avatar zdne avatar

Watchers

 avatar  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.