Installation

gem'grape'gem'grape-rabl'

$ bundle

Upgrading

Usage

Setup view root directory

# config.ruuseRack::Configdo |env|env['api.tilt.root']='/path/to/view/root/directory'end

Tell your API to use Grape::Formatter::Rabl

classAPI <Grape::APIformat:jsonformatter:json,Grape::Formatter::Rablend

Use rabl templates conditionally

get"/user/:id",:rabl=>"user.rabl"do@user=User.find(params[:id])end

object@user=>:userattributes:name,:emailchild@project=>:projectdoattributes:nameend

Use rabl layout

# config.ruuseRack::Configdo |env|env['api.tilt.root']='/path/to/view/root/directory'env['api.tilt.layout']='layouts/another'end

Enable template caching

# config.ruGrape::Rabl.configuredo |config|config.cache_template_loading=true# default: falseend

You can omit .rabl

get"/home",:rabl=>"view"get"/home",:rabl=>"view.rabl"

Example

# config.ruuseRack::Configdo |env|env['api.tilt.root']='/path/to/view/root/directory'endclassUserAPI <Grape::APIformat:jsonformatter:json,Grape::Formatter::Rablget'/user/:id'do@user=User.find(params[:id])# use rabl with 'user.rabl' or 'admin.rabl' templateif@user.admin?# pass locals with the #render methodrenderrabl:'admin',locals:{details:'this user is an admin'}elserenderrabl:'user'endendget'/admin/:id',:rabl=>'admin'do@user=User.find(params[:id])# use rabl with 'super_admin.rabl'renderrabl:'super_admin'if@user.super_admin?# when render method has not been used use template from endpoint definitionend# use rabl with 'user_history.rabl' templateget'/user/:id/history',:rabl=>'user_history'do@history=User.find(params[:id]).historyend# do not use rabl, fallback to the default Grape response formatterget'/users'doUser.allendend

# user.rablobject@user=>:userattributes:name

Usage with rails

# app/api/user.rbclassMyAPI <Grape::APIformat:jsonformatter:json,Grape::Formatter::Rablget'/user/:id',:rabl=>"user"do@user=User.find(params[:id])endend

# app/views/api/user.rablobject@user=>:user

# application.rbclassApplication <Rails::Applicationconfig.middleware.use(Rack::Config)do |env|env['api.tilt.root']=Rails.root.join"app","views","api"endend

# routes.rbGrapeExampleRails::Application.routes.drawdomountMyAPI,:at=>"/api"end

Specs

Contributing