Use active_model_serializers with Grape!
Add the grape
and grape-active_model_serializers
gems to Gemfile.
gem 'grape'
gem 'grape-active_model_serializers'
And then execute:
bundle
# config.ru
require 'grape/active_model_serializers'
class API < Grape::API
format :json
formatter :json, Grape::Formatter::ActiveModelSerializers
end
grape-active_model_serializers will search for serializers for the objects returned by your grape API.
namespace :users do
get ":id" do
@user = User.find(params[:id])
end
end
In this case, as User objects are being returned, grape-active_model_serializers will look for a serializer named UserSerializer.
You can turn off serializer inferrence.
Grape::Formatter::ActiveModelSerializers.infer_serializers = false
Serializers can be specified at a route level by with the serializer option. A serializer can be specified by passing the the serializer class or the serializer name. The following are equivalent:
get "/home", :serializer => HomeSerializer
...
get "/home", :serializer => "home"
...
get "/home", :serializer => :home
...
You can also set a serializer at the namespace level. This serializer can/will be overriden if a serilizer is also specified on the route.
namespace 'foo', :serializer => :bar do
get "/" do
# will use "bar" serializer
end
get "/home", :serializer => :home do
# will use "home" serializer
end
end
Other standard options for ActiveModel::Serializers
can be provided at either the namespace or route level with the same overriding behavior.
get "/home", :root => 'world', :each_serializer => :fancy_home
...
class User < ActiveRecord::Base
attr_accessor :first_name, :last_name, :password, :email
end
class UserSerializer < ActiveModel::Serializer
attributes :first_name, :last_name
end
class API < Grape::API
get("/home") do
User.new({first_name: 'JR', last_name: 'HE', email: '[email protected]'})
end
end
API.new.get "/home" # => '{:user=>{:first_name=>"JR", :last_name=>"HE"}}'
See "Writing Tests" in https://github.com/intridea/grape.
Enjoy :)
- 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
The developers and maintainers of: active_model_serializers Grape!
Structured and based upon Grape.