mcpField
A
api-platform-serialization

api-platform-serialization

github.com/dev-toolingsDevelopment22778 installsUpdated 3w ago
Repository

About api-platform-serialization

A Symfony skill for configuring API Platform serialization across operations. It guides field groups, relation rendering, computed fields, and safeguards such as depth limits and hiding secrets.

Key features

  1. 01Operation-specific serialization groups
  2. 02IRI or embedded relations
  3. 03Computed and role-dependent fields
  4. 04Property-level normalizer options
  5. 05Cycle and secret-field safeguards

Use cases

  1. 01Expose different fields for list and read operations
  2. 02Control whether related resources are embedded
  3. 03Format dates without a custom normalizer
  4. 04Add computed fields while keeping entities clean

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/dev-toolings/superpowers-symfony --skill api-platform-serialization

After installing, type/api-platform-serializationin Claude Code to confirm it loaded.

Bundled filesreference.md

Details

From the project README

Api Platform Serialization (Symfony)

Use when

  • Operations must expose different fields (list, read, create, update).
  • A related resource must render as an IRI or be embedded.
  • A response needs computed or role-dependent fields.
  • A property needs normalizer options such as a date format.

Default workflow

  1. Name groups entity:operation and set normalizationContext and denormalizationContext per operation.
  2. Tag properties with #[Groups] from the Serializer Attribute namespace, not the old Annotation one.
  3. Control relations with #[ApiProperty(readableLink: false, writableLink: false)] to force IRIs.
  4. Apply per-property options with #[Context] instead of writing a normalizer.
  5. Add computed fields in a custom normalizer, and dynamic groups in a decorator of api_platform.serializer.context_builder.
  6. Prevent cycles with #[MaxDepth] and enable_max_depth, and hide secrets with #[Ignore].

Guardrails

  • Use separate read and write groups: for example password only in the create group, id only in read groups.
  • A related resource is embedded only when it shares a group with the parent; otherwise it renders as an IRI.
  • #[MaxDepth] has no effect unless enable_max_depth is true in the context.
  • Keep entities clean: computed fields belong in normalizers.

Progressive disclosure

  • Use this file for execution posture and risk controls.
  • Open references when deep implementation details are needed.

Output contract

  • The groups and contexts per operation, as a field matrix.
  • Normalizers or context builders added, and how they are registered.
  • Tests or OpenAPI output showing the resulting fields.

References

  • reference.md

Comments

Markdown supported