Testing APIary using Dredd.

Test API blueprint mardown files by simply hosting them on GitHub and setting up a pipeline in Travis CI.

Wed, 02 Jul 2014

API Blueprint is a documentation-oriented API description language. A couple of semantical assumptions over the plain Markdown.

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

I could able to setup dredd quite easily on my Mac by installing Node and npm. However its not quite straight forward in Windows. I faced lots of difficulties while installing node, npm and dredd.

So i decided to use Travis to setup the testing pipeline for my jobs. All i needed to do is to have a .travis.yml file to install node_js and install dredd using npm.

Added a simple script file to run the dredd tool inside the job. And that’s it. As part of the code i also checked in the API markdown files which will run againt the APIs


Prasanna is a full stack web developer, loves to build user interfaces with Javascript. Considers himself as a geek, quick learner and a team player 😃

  • rants and writings through personal experience