API Blueprint Focus Booster is a collection of Gulp tasks that help you write large API Blueprints efficiently.
This tool lets you split one huge document into smaller ones so you can easily edit them in your favorite text editor.
When you're done, it will validate your API Blueprints (JSON payloads), concatenate them into one file and publish the resulting API Blueprint into the Apiary.io.
- Substitutes commonly used values (templating).
- Validates JSON strings inside files (payloads).
- Converts hard tabs to spaces.
- Concatenates all files into one output file.
- Publishes to Apiary.io.
Preferred way is to use Slush generator for API Blueprint Focus Booster.
Clone this repository.
git clone https://github.com/saamo/api-blueprint-focus-booster.git
Since this tool is powered by Gulp, you need to install all the dependencies via NPM first.
cd api-blueprint-focus-booster
npm install
And finally copy the example config file.
cp config.example.js config.js
Put your files (with .apib
extension) into the ./src
directory and run following command.
gulp
Resulting API Blueprint is saved in ./build/output.apib
file.
In order to use publish task, you need to install the Apiary CLI first.
gem install apiaryio
Setup API name and token in the config file and then publish your API Blueprint using following command.
gulp publish
MIT © Samir Djellil