Rails JSON API serializer with custom attributes

Question

I am working on an RoR project with ruby-2.5.0 and rails 5. I am using the jsonapi-serializers for my API. I want to customize the attributes of the associated model. I have two models Receipt and ReceiptPartial. receipt has_many :receipt_partials. when I write has_many :receipt_partials in my serializer it returns all the columns but I want only a few columns.

class ReceiptPartialSerializer
  include JSONAPI::Serializer

  TYPE = 'receipt'
  attribute :id
  has_many :receipt_partials
end

I want to restrict the columns of receipt_partials. I also tried has_many :receipt_partials, only: ['id'] but didnot work. How can I achieve this? Please help. Thanks in advance.

Jai Kumar Rajput · Accepted Answer · 2022-09-26 08:52:03Z

1

Based on the documentation, you should simply specify the attributes on the relevant serializer class for example if you want to display id, and name attributes in ReceiptPartial Serializer you could do the following.

class BaseSerializer
  include JSONAPI::Serializer
end

class ReceiptSerializer < BaseSerializer
  TYPE = 'receipt'
  attribute :id

  has_many : receipt_partials
end

class ReceiptPartialSerializer < BaseSerializer
  attributes :id, :name
end

edited Sep 26, 2022 at 8:52

Jai Kumar Rajput

4,2273 gold badges41 silver badges67 bronze badges

answered Jun 10, 2018 at 6:29

Shani

2,5413 gold badges20 silver badges23 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

Rails JSON API serializer with custom attributes

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related