CODEWITHSUNDEEP
ruby-on-railsrubyfastjsonapi
ilrock
ilrock

Reputation: 593

How to get the fast_jsonapi to return the attributes of the relationships

I have a rails api with a number of models that are being serialized by the fast_jsonapi gem.

This is what my models look like:

class Shift < ApplicationRecord
  belongs_to :team, optional: true
  ...

class Team < ApplicationRecord
  has_many :shifts
  ...

This is what the serializer looks like

class ShiftSerializer
  include FastJsonapi::ObjectSerializer
  ...
  belongs_to :team
  ...
end

The serialization works. However, even though I am including the compound team document:

def index
  shifts = policy_scope(Shift).includes(:team)
  options = {}
  options[:include] = [:team, :'team.name', :'team.color']
  render json: ShiftSerializer.new(shifts, options)
end

I'm still getting the object formatted like so:

...
relationships: {
  team: {
    data: {
      id: "22",
      type: "Team"
    }
  }
}

Whereas I'm expecting to get also the attributes of my team model.

Upvotes: 7

Views: 10092

Answers (3)

nirav kanani
nirav kanani

Reputation: 77

If you use like this then maybe solve your problem

class Shift < ApplicationRecord
    belongs_to :team, optional:true
    accepts_nested_attributes_for :team
end

In your ShiftSerializer.rb please write this code,

attribute :team do |object|
    object.team.as_json
end

And you will get custom data that you want.

Reference: https://github.com/Netflix/fast_jsonapi/issues/160#issuecomment-379727174

Upvotes: 0

David Metta
David Metta

Reputation: 101

If you use the options[:include] you should create a serializer for the included model, and customize what is included in the response there.

in your case if you use

ShiftSerializer.new(shifts, include: [:team]).serializable_hash

you should create a new serializer serializers/team_serializer.rb

class TeamSerializer
  include FastJsonapi::ObjectSerializer

  attributes :name, :color
end

this way your response will be

{
  data: [
    {
      id: 1,
      type: "shift",
      relationships: {
        team: {
          data: {
            id: "22",
            type: "Team"
          }
        }
      }
    }
  ],
  included: [
    id: 22,
    type: "Team",
    attributes: {
       name: "example",
       color: "red"
    }
  ]
}

and you will find the custom data of your association in the response "included"

Upvotes: 1

Yurii
Yurii

Reputation: 691

fast_jsonapi implements json api specification so respond includes "included" key, where serialized data for relationships placed.That's default behavior

enter image description here

Upvotes: 4

Related Questions