README.md

Railsblocks API Spec

The idea of this project is allows write several files separated according to the desired structure and join them into one file at the time of testing the API

To use Railsblocks API Spec, we got the api-blueprint-focus-booster amazing project from Samir Djellil, and change some configurations.

Install

Clone this repository.

git clone https://github.com/railsblocks/railsblocks-api-spec.git

Install all the dependencies via NPM first.

cd railsblocks-api-spec
npm install

Usage

Put your files (with .apib extension) into the ./src directory and run following command.

gulp

Resulting API Blueprint is saved in ./build/railsblocks-api-spec.apib file.

Run dredd command to test the api

dredd

License

MIT © Railsblocks