api-interface-design

Use this skill for REST/RPC contracts, versioning, error shapes, schemas, backward compatibility. Trigger when the task involves programming work related to API Interface Design, production implementa

SKILL.md

GitHub

API Interface Design

Start from callers and ownership boundaries. Record request/response schemas and expected error semantics.

Decisions

  • Specify identifiers, nullability, authorization/tenant scope, pagination ordering, idempotency, timeout, and retry policy.
  • Use machine-readable schemas where the stack supports them. Preserve large integer identifiers without precision loss.
  • Version breaking changes or provide a migration path; do not silently reinterpret existing fields.

Acceptance

Test valid and invalid input, auth failures, empty pages, duplicate retries, and old-client behavior. Confirm implementation matches the documented schema.