API and Interface Design

Acerca de este Skill

Design stable API contracts with typed inputs, consistent errors, pagination and explicit retry semantics. Define consumers and schemas first, then check additive changes, pagination and atomic idempotency handling.

Por qué lo elegimos

A task workflow in Addy's Agent Skills. Follow the upstream instructions and retain referenced shared files; host capabilities and project configuration determine which steps can run.

Para qué sirve

• A new endpoint or module boundary needs a contract before implementation.

Workflow and deliverables

Define consumers and schemas first, then check additive changes, pagination and atomic idempotency handling.

Typed request and response contracts, boundary validation, consistent errors and documented compatibility and idempotency decisions.

API and Interface Design instructions

Install with the required references

Install the complete pack through a documented repository integration when shared references are needed. A per-skill skills CLI install copies only skills/<name>/ and can omit the repository-level references/ checklists; keep the needed shared files with the workflow.

Upstream overview and integrations

Antes de usarlo

• An Agent that can load Skill Markdown and access your project. File edits, shell commands, builds and checks depend on the selected workflow and its environment.
• Use your project's own runtimes, dependencies and verification commands. The Skill files provide instructions and do not install those project tools.
• Install the complete pack through a documented repository integration when shared references are needed. A per-skill skills CLI install copies only skills/<name>/ and can omit the repository-level references/ checklists; keep the needed shared files with the workflow.

Agentes compatibles