Reference

Detailed reference for Panko’s API and DSL.

• Serializers: the Panko::Serializer / Panko::ArraySerializer API, with serialize methods, constructor options and context / scope.
• Attributes: field attributes, method attributes, and aliases.
• Associations: has_one and has_many, aliasing, and serializer inference.
• Filters: only / except, nested filters, filters declared on an association, and filters_for.
• Response: Panko::Response and Panko::JsonValue for composing responses.
• Configuration: Panko.configure, the auto-specialization and writer pool settings, and Panko.compile_all.
• Descriptor: Panko::Descriptor, the read-only view of a serializer’s shape for preloaders and other tooling.

---

Table of contents

• Serializers
• Attributes
• Associations
• Filters
• Response
• Configuration
• Descriptor