Associations
A serializer can nest other serializers through has_one and has_many, each serializing a related object under the current one:
class PostSerializer < Panko::Serializer
attributes :title, :body
has_one :author, serializer: AuthorSerializer
has_many :comments, each_serializer: CommentSerializer
end
Use serializer: for has_one and each_serializer: for has_many.
Aliasing an association
An association’s output key can be renamed with the name: option. Here the actual_author relation is emitted as author:
class PostSerializer < Panko::Serializer
attributes :title, :body
has_one :actual_author, serializer: AuthorSerializer, name: :author
has_many :comments, each_serializer: CommentSerializer
end
The name: key is emitted as written, even when key_transform is set.
When filtering, refer to an aliased association by its declared name (the first argument), not the
name:alias. See Filters.
Conditional associations
Pass if: a lambda to include an association only for some records. When it returns a falsy value, the key is left out of the output and the association is not read.
class PostSerializer < Panko::Serializer
attributes :title, :body
has_one :author, serializer: AuthorSerializer, if: ->(post, context) { context[:with_author] }
has_many :comments, each_serializer: CommentSerializer, if: ->(post) { post.published? }
end
The lambda takes zero to three arguments: the record, the context: and the scope: given to the serializer. Keep it free of side effects. A Symbol is rejected at declaration; wrap a method call in a lambda instead.
Serializer inference
If you omit serializer: / each_serializer:, Panko infers it from the association name:
class PostSerializer < Panko::Serializer
attributes :title, :body
has_one :author # => AuthorSerializer
has_many :comments # => CommentSerializer
end
The inference rule:
- Take the association name (
:author,:comments), singularize and camelize it. - Look for a constant with that name plus a
Serializersuffix (AuthorSerializer,CommentSerializer).
If Panko can’t find a matching serializer, it raises at load time, e.g.
Can't find serializer for PostSerializer.author has_one relationship.
Filtering associations
Associations can be filtered, and their own attributes narrowed, with nested filters passed at serialization time, or with only: / except: on the has_one / has_many declaration. See Filters.