Review REST API designs before implementation for versioning, security, and contract clarity
Review an API design, endpoint set, or OpenAPI spec before implementation and return prioritized findings on design quality, security, resilience, and missing contract decisions.
Prerequisites
Claude Code skill runtime
Installation
Requirements and caveats from upstream:
- | Language | TypeScript, Python, Go, Java, Rust, Ruby, C#, and more |
- deploy/ — CI/CD pipelines, Docker, deploy scripts
- Skills 2.0: allowed-tools: Read Grep Glob Write Bash(git *) — argument-hint: [path/to/scope] — auto-invokes on trigger phrases; requires git for churn analysis
Basic usage or getting-started notes:
├── article-example.md Article with callouts + code blocks
├── meeting-brainstorm-example.md Brainstorming session
└── transcript-example.md Article with transcript appendix
Source: https://github.com/psenger/ai-agent-skills/tree/main/skills/review-api-design
Extracted from upstream docs: https://raw.githubusercontent.com/psenger/ai-agent-skills/HEAD/README.md