API Design Reviewer
Comprehensive REST API design review with automated linting, breaking-change detection, and design scorecards.
Before & after
Same prompt, same agent — the only difference is the skill.
API design is important for making your API usable and predictable. You'd want consistent naming conventions across endpoints and consistent response formats. Versioning strategies help with managing changes over time. Documentation is critical so users understand how to use your API. You might also think about security, rate limiting, and error handling. Breaking changes can cause problems for existing users, so it's good to be careful about that. There are various guidelines and best practices for API design that you could reference.
API DESIGN REVIEW SCORECARD FOR V2 LAUNCH:
CONSISTENCY AUDIT
Naming conventions:
✓ Nouns for resources: GET /v2/accounts, POST /v2/invoices
✓ Verbs as subresources: POST /v2/accounts/123/invite
✓ Snake_case for fields: created_at, account_id, not createdAt
Response format:
✓ Success: { status: 'success', data: {...} }
✓ Error: { status: 'error', code: 'VALIDATION_FAILED', message: '...' }
✓ All endpoints return consistent wrapper (no inconsistent raw arrays)
BREAKING CHANGES DETECTED
1. BLOCKER: GET /v1/reports → removed, no deprecation period
→ Add v1 endpoint with 301 redirect to v2
2. WARNING: POST /v2/accounts now requires 'billing_email' (was optional)
→ Add default behavior or deprecation warning header
3. MINOR: Response field 'user_count' renamed to 'active_users'
→ Include both fields in transition period
DESIGN SMELLS FOUND
• Endpoint GET /v2/accounts/search missing pagination (could return 100K+ results)
→ Add limit/offset parameters
• PATCH /v2/invoices accepts full invoice object, but only updates 3 fields
→ Clarify docs which fields are patchable
DESIGN SCORECARD
Endpoint consistency: 9/10 (naming and structure clear)
Documentation completeness: 7/10 (missing error code glossary)
Versioning strategy: 8/10 (no sunset date for v1)
Security: 8/10 (missing rate-limit headers in response)
RECOMMENDATION: Ship v2 after fixing breaking-change warnings
About this skill
name: api-design-reviewer description: Use when Comprehensive REST API design review with automated linting, breaking-change detection, and design scorecards.
Api Design Reviewer
Comprehensive REST API design review with automated linting, breaking-change detection, and design scorecards. Catches inconsistent conventions, missing versioning, and design smells before APIs ship. Use when reviewing a PR that adds or changes API endpoints, auditing an existing API for v2 migration, or establishing API standards for a team.
What you get
- Public GitHub repo (alirezarezvani/claude-skills)
- the api-design-reviewer skill folder with SKILL.md. Part of a 337-skill / 30-agent / 70-command install.
Customize your output
- Fork the repo and adapt the skill's instructions and references to your workflow.
Example output
Activates automatically when your request matches Api Design Reviewer; chains with the other skills, agents, and commands in the collection.
Best for
Creators, builders, and teams using Claude Code.
SKILL.md preview
---
name: api-design-reviewer
description: Perform a structured REST API design review that lints conventions, flags breaking changes, and scores the design against a rubric.
version: 1.0.0
category: Development / Engineering
author: AgentVolt
license: proprietary
tags:
- development
- engineering
---
# Api Design Reviewer
Perform a structured REST API design review that lints conventions, flags breaking changes, and scores the design against a rubric.
## When to use
… (sign up to view the full skill)More development skills
View all Development skills →Generate
Scaffold code, tests, and boilerplate from a short spec.
Performance Profiler
Systematic performance profiling for Node.js, Python, and Go applications.
Threat Detection
Use when hunting for threats in an environment, analyzing IOCs, or detecting behavioral anomalies in telemetry.
Agent Harness
Turns a domain folder of skills into a bounded agentic loop: compile a goal into a task plan, execute with the domain's tools, verify every task, retry within a budget.