What is api-platform-openapi?

A guide to customizing API Platform 4.3's automatically generated API documentation, including OpenAPI, Hydra and Scalar.

Use it to document or hide API operations, add metadata, mark endpoints as deprecated, choose a documentation interface or export the API specification.

It helps keep endpoint descriptions, request and response details, security information and public documentation accurate as the API changes.

api-platform-openapi — Skill by gerard-labs

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods

npx agentmods add skills/gerard-labs/superpowers-api-platform/api-platform-openapi

Any agent

npx skills add gerard-labs/superpowers-api-platform --skill api-platform-openapi

Clone the repo

git clone --depth 1 https://github.com/gerard-labs/superpowers-api-platform

Made for: Claude Code, Codex.

Per session 204 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.

When invoked 736 The whole file, excluding the scripts and references it only reads on demand.

Security scan A 0 findings. Scan, not verified.

Origin original No closer match found in the catalogue.

Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

Model	Per session	Once invoked
Fable 5	$0.00204	$0.00736
Opus 5	$0.00102	$0.00368
Sonnet 5	$0.00041	$0.00147
Haiku 4.5	$0.00020	$0.00074

Measured 2d ago against content hash 1efa5a7caa14, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

api-platform-openapi scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

skills/api-platform-openapi/SKILL.md · 48 lines

How it starts

The opening of the file, as written. The whole thing — 48 lines — stays where its author put it; the contents beside it link to each section on GitHub.

API Platform 4.3 — OpenAPI / Hydra / Scalar

Use when

Adding openapi: new Model\Operation(...) to an operation (summary, description, tags, requestBody, responses).
Decorating the OpenAPI factory to inject corporate Info / x-logo / Server.
Enabling Scalar UI on top of the default Swagger UI.
Hiding internal operations from the doc (openapi: false).
Marking operations as deprecated (Model\Operation(deprecated: true)).
Exporting the spec for an API Gateway or partner.

Default workflow

Set global OpenAPI metadata via a factory decorator (#[AsDecorator(decorates: 'api_platform.openapi.factory')]).
Per operation, attach openapi: new Model\Operation(summary, description, tags, requestBody, responses).
For partner-facing endpoints, choose the UI: Swagger (default), ReDoc, Scalar (?ui=scalar).
Export and review the spec (php bin/console api:openapi:export --yaml).
Document architectural decisions in docs/adr/ (ADR-XXXX.md).

Guardrails

No openapiContext — it is deprecated. Use openapi: new Model\Operation(...).
Security in OpenAPI: align Model\Operation(security: [['bearerAuth' => []]]) with the global swagger.api_keys config.
Tags consistency: pick a short list (['Books', 'Public']) and apply it everywhere.
Schemas vs groups: every group affects the OpenAPI schema — use openapi_definition_name to disambiguate when needed.

Progressive disclosure

SKILL.md lists posture and rules.
reference.md carries the full attribute usage, the factory decorator, Info / Server / Contact / License, custom OpenApiParameter, vendor extensions, Scalar configuration, export commands, security schemes, ADR template.

Output contract

Operations carry openapi: new Model\Operation(...) (never openapiContext).
A factory decorator publishes corporate metadata.
Spec exports validated (api:openapi:export).
ADRs in docs/adr/ document non-trivial decisions.

References

reference.md

Read the full file on GitHub · 48 lines

Files

What ships with it

1 file beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

reference.md 8.3 KB

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

2d ago First seen · 48 lines · 0 tokens per session scan A 1efa5a7caa14

Subscribe to this mod's changes

api-platform-openapi is a skill published in the GitHub repository gerard-labs/superpowers-api-platform (2 stars, last pushed 3mo ago), licensed MIT. It adds 204 tokens to every session and 736 once invoked, about $0.0010 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

Backend and APIs api api-platform claude claude-code claude-code-plugin symfony

server-setup

Initialize tRPC with initTRPC.create(), define routers with t.router(), create procedures with .query()/.mutation()/.subscription(), configure context with createContext(), export AppRouter type, merge routers with t.mergeRouters(), lazy-load routers with lazy().

trpc/trpc · 56 tokens

client-setup

Create a vanilla tRPC client with createTRPCClient (), configure link chain with httpBatchLink/httpLink, dynamic headers for auth, transformer on links (not client constructor). Infer types with inferRouterInputs and inferRouterOutputs. AbortController signal support. TRPCClientError typing.

trpc/trpc · 63 tokens

non-json-content-types

Handle FormData, file uploads, Blob, Uint8Array, and ReadableStream inputs in tRPC mutations. Use octetInputParser from @trpc/server/http for binary data. Route non-JSON requests with splitLink and isNonJsonSerializable() from @trpc/client. FormData and binary inputs only work with mutations (POST).

trpc/trpc · 75 tokens

caching

Set HTTP cache headers on tRPC query responses via responseMeta callback for CDN and browser caching. Configure Cache-Control, s-maxage, stale-while-revalidate. Handle caching with batching and authenticated requests. Avoid caching mutations, errors, and authenticated responses.

trpc/trpc · 54 tokens

portaljs-connect-ckan

Wire a scaffolded PortalJS portal to a CKAN backend over its API. Generates a tiny server-side fetch client (no runtime dependency) and feeds the /search catalog and /@namespace/slug showcases from CKAN instead of datasets.json. Use when connecting an existing portal to a live CKAN instance instead of a static…

datopian/portaljs · 74 tokens

horse-grpc

Guidelines and workflows for developing and maintaining gRPC services, HTTP/2 h2c transport, and Protobuf serialization within the Horse framework.

HashLoad/horse · 33 tokens