Name: apiblueprint-rails
Owner: Wantedly, Inc.
Description: apiblueprint-rails creates API Blueprint boilerplate when calling 'rails g apiblueprint'.
Created: 2016-04-26 06:33:55.0
Updated: 2018-04-15 00:40:19.0
Pushed: 2016-05-11 14:07:03.0
Size: 15
Language: Ruby
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
apiblueprint-rails creates API Blueprint boilerplate when calling rails g apiblueprint.
Add this line to your rails application's Gemfile:
'apiblueprint-rails'
And then execute:
ndle
After installing apiblueprint-rails to your rails application, use apiblueprint keyword to generate scaffold. For example,
ils 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.
ils g apiblueprint --generate=none User name age:integer admin:boolean
generates just the same apib output above.
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.
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/apiblueprint-rails.
The gem is available as open source under the terms of the MIT License.