api-platform-resources_skill

Overview

This skill delivers clear, actionable API Platform resource contracts for Symfony projects. It helps define explicit operations, DTOs, mapping, validation, and security so your API behavior matches documentation and expectations. Use it to reduce ambiguity, prevent accidental data leaks, and keep contract drift under control.

How this skill works

The skill inspects resource definitions and operation-level contracts, then produces changes to resources, DTOs, providers, and processors with explicit mapping rules. It also applies operation-specific validation and security constraints and produces a short rationale for decisions. Finally, it includes functional verification notes for happy and negative paths to confirm behavior.

When to use it

• Designing or evolving API Platform resource contracts and operation boundaries
• Aligning serialization groups, validation, and security per operation
• When preventing implicit exposure of internal entity fields
• Before a public API release or version bump to avoid contract drift
• When adding DTOs or custom providers/processors to reshape payloads

Best practices

• Keep contract definitions explicit and version-aware; treat operations as first-class artifacts
• Map DTOs to entities with explicit field mappings rather than relying on default serialization
• Apply operation-level validation and security rules, not just global rules
• Document rationale for contract and security decisions alongside code changes
• Include functional checks for both happy paths and negative/edge cases

Example use cases

• Convert an internal entity to a public-facing DTO with explicit read/write operations
• Add a custom POST processor that validates and authorizes a complex payload before persistence
• Lock down a sensitive field so it is excluded from serialization in certain operations
• Version an endpoint by introducing a new resource contract while keeping legacy behavior intact
• Verify that OpenAPI docs and serialization groups accurately reflect runtime behavior