A Ruby library for generating REST Api documentation using API Blueprint
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
example
lib
spec
.gitignore
.rspec
.travis.yml
Gemfile
LICENSE.txt
README.md
Rakefile
apitecto.gemspec
docker-compose.yml

README.md

Apitecto

Finally I'm having time to work in this!!!! No more lame-itecto!

Installation

Add this line to your application's Gemfile:

gem 'apitecto'

And then execute:

$ bundle

Or install it yourself as:

$ gem install apitecto

Usage

Some notes while I make a proper and decent readme:

  1. Create the apitecto initializer on spec/support/apitecto.rb
  2. You can see a pretty version of your generated api blueprint using aglio

TODO: Write usage instructions here

Contributing

  1. Fork it ( https://github.com/vovimayhem/apitecto/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request