Jbuilder::Jsonapi
Jbuilder extension that makes following the JSON API conventions easier.
Usage
This library will extend Jbuilder and add a few methods to the json
object in the templates.
Resource Methods
links!
The value of the "links" key is a JSON object that represents related resources.
json.links do
json.links! post, :comments, :user
end
# =>
# {
# "links": {
# "comments":["1","2","3"],
# "user":"42"
# }
# }
Installation
Add this line to your application's Gemfile:
gem 'jbuilder-jsonapi'
And then execute:
$ bundle
Or install it yourself as:
$ gem install jbuilder-jsonapi
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request
License
Distributed under the MIT license. See LICENSE for details.