CollectionJson

A gem to help with producing Hypermedia APIs with a MIME type of 'application/vnd.collection+json'

see http://amundsen.com/media-types/collection/format/#link-relations

Installation

Add this line to your application's Gemfile:

gem 'collection_json'

And then execute:

$ bundle

Or install it yourself as:

$ gem install collection_json

Usage

This is still experimental at the moment. The aim is to be able to include the gem in a Rack app and make for easy generation of hypermedia APIs from your resources, effectively something like a hypermedia presenter.

I'm not clear on the details of how the objects will be presented as Collection+JSON as there is an emphasis on Collections rather than individual items. This makes sense if you think of Rails controllers being plural.

But it is reasonably different to being used to having the primary unit of data being a singular model.

  SingularActiveRecordObject.all

  #versus:
  PluralJsonCollection.new collection_of_objects

Contributing

Fork it
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Added some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request