agentleFS
gerard-labsgerard-labs/superpowers-api-platform/skills/api-platform-resources/SKILL.md

api-platform-resources

Skill2 starsChanged 6 months agoMITView on GitHub

Design or evolve API Platform 4.3 resources — choose operations (Get/GetCollection/Post/Put/Patch/Delete), apply the Resource-First principle (Resource ≠ Entity), enforce the IRI-only relation rule, model subresources with Link(fromClass:, toProperty:), set shortName / uriTemplate / itemUriTemplate, configure content negotiation (formats, patch_formats, LDP Allow/Accept-Post 4.3), and avoid the legacy Symfony controllers pattern. Trigger on requests like "create an API resource", "add an operation", "expose nested orders under a customer", or "model a subresource".

1 other project uses a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

1 rule. About 0 are common, 0 are distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    No magic operations: declare each one.

    line 31

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

API Platform 4.3 — Resources & operations

Use when

  • Designing a new #[ApiResource] or evolving an existing one.
  • Choosing which operations to expose and how to scope them.
  • Modeling subresources (orders under a customer, items under an order).
  • Forcing the IRI-only rule on relations.

Default workflow

  1. Define the operation boundary — which payload, which invariants, which actor.
  2. Declare the operations explicitly (new Get(...), new Post(...), etc.) with per-operation groups, security, validation.
  3. Apply the Resource-First principle — keep the Resource decoupled from the Entity unless they are genuinely identical.
  4. Validate the contract end-to-end (debug:router, api:openapi:export, functional tests).

Guardrails

  • Resource ≠ Entity. The Resource is the external contract; do not let it leak Doctrine specifics.
  • IRI-only on relations: never accept a scalar int $customerId, always a Customer $customer that API Platform resolves from /api/customers/....
  • No use_symfony_listeners: true unless you really need a Symfony controller — the providers/processors path is preferred.
  • No magic operations: declare each one. paginationItemsPerPage default is 30 in 4.x (not 20).

Progressive disclosure

  • SKILL.md covers posture and decisions.
  • reference.md carries the full 4.3 patterns: subresources with Link, itemUriTemplate, content negotiation, anti-patterns, legacy controllers (to avoid).

Output contract

  • Updated #[ApiResource] attributes with explicit operations and contexts.
  • Justification for IRI-only (or, exceptionally, embedded) choices.
  • Functional test coverage on each operation, including 404 / 401 / 403 / 422.
  • Generated routes confirmed via php bin/console debug:router | grep api.

References

  • reference.md

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.