Skip to content

csexton/jbuilder-jsonapi

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

  1. Fork it
  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 new Pull Request

License

Distributed under the MIT license. See LICENSE for details.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages