api-design-rest

Installation
SKILL.md

API Design REST

Scope Boundaries

  • Use when REST resources, URI structures, and HTTP behavior are being designed or changed.
  • Use proactively when route, method, status, or schema diffs appear in specs, manifests, or source.
  • Use when request-response transport options are being compared and REST is a candidate.
  • Do not use for GraphQL-first schema work; use api-design-graphql.
  • Do not use for storage internals; use db-*.

Goal

Deliver REST contracts that are stable, predictable, and operationally safe.

Shared API Contract (Canonical)

  • Use references/api-governance-contract.md as the primary reference for recommended structure.
  • Optional consistency checks (only if your repository enforces manifest validation):
    • python3 scripts/validate_api_contract.py --manifest <path/to/manifest.json>
  • Start from valid templates in assets/.
  • Use transport decision reference:
    • references/transport-selection-matrix.md
Related skills

More from kentoshimizu/sw-agent-skills

Installs
6
GitHub Stars
5
First Seen
Feb 28, 2026