Booqable API Documentation
This repository contains the source for the Booqable API documentation https://developers.booqable.com/
Warning: Our API is still in Beta and we might introduce non-backwards compatible changes in the future.
You're going to need:
- Linux or OS X — Windows may work, but is unsupported.
- Ruby, version 2.3.1 or newer
- Bundler — If Ruby is already installed, but the bundle command doesn't work, just run gem install bundler in a terminal.
Getting Set Up
- Clone this repository
- Initialize and start Slate. You can either do this locally, or with Vagrant:
# either run this to run locally
bundle exec middleman server
# OR run this to run with vagrant
You can now see the docs at http://localhost:4567. Whoa! That was fast!
Slate - API docs generator
The API is going to be a very important part of our eco system. We've designed the docs in a way every developer is able to contribute to our API. If you find a bug or you have a great suggestion open an issue or pull request.