Desponders

A stack of light-weight responders tailored to JSON APIs.

Installation

Add this line to your application's Gemfile:

gem 'desponders', '~> 0.2.0'

Usage

Create a ActionController::Responder subclass and include the responders that you would like to use:

class CustomResponder < ActionController::Responder
  include Desponders::ErrorResponder
  include Desponders::RESTResponder
  include Desponders::PaginatedResponder
  include Desponders::HTTPCacheResponder
end

Include the responder in any controllers serving API requests:

class ApplicationController < ActionController::Base
  self.responder = CustomResponder
end

PaginatedResponder

The PaginatedResponder automatically applies pagination to every multi resource GET request. In order for pagination to work your resources must respond to a paginate method that accepts page and per_page options.

Thanks

The implementation of Desponders is based on the fanstastic work of Jose Valim and his contributions to Responders within Rails, as well as Plataformatec's Responders gem.

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