Skip to content
This repository has been archived by the owner. It is now read-only.
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
bin
 
 
lib
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

apiblueprint-rails

apiblueprint-rails creates API Blueprint boilerplate when calling rails g apiblueprint.

Installation

Add this line to your rails application's Gemfile:

gem 'apiblueprint-rails'

And then execute:

$ bundle

Usage

After installing apiblueprint-rails to your rails application, use apiblueprint keyword to generate scaffold. For example,

$ rails g apiblueprint User name age:integer admin:boolean

creates doc/users.apib file.

You can change doc directory by passing --apidoc-dir=<directory> flag to the option.

If you want to generate apiblueprint only, you can use rails generate apiblueprint --generate=none command.

$ rails g apiblueprint --generate=none User name age:integer admin:boolean

generates just the same apib output above.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/apiblueprint-rails.

License

The gem is available as open source under the terms of the MIT License.

About

apiblueprint-rails creates API Blueprint boilerplate when calling 'rails g apiblueprint'.

Resources

License

Packages

No packages published