REST API Design Review

Review the following API design: $ARGUMENTS

If no design was provided above, ask for an API design to review (OpenAPI spec, endpoint list, or verbal description).

This skill vets API designs before implementation — during the planning phase. It reviews contracts, endpoint structures, and architectural decisions against proven best practices. Reviews are constructive but thorough — challenging the design, flagging gaps, and surfacing trade-offs.

When This Skill Activates

• An OpenAPI/Swagger specification (YAML or JSON)
• A list of endpoints with descriptions
• A verbal description of an API being planned
• A diagram or document describing API architecture
• Questions about how to design specific API aspects

Workflow

Step 1: Understand the Context