api-designer

What it does

The API Designer skill provides a structured framework for architects and developers to build robust, scalable interfaces. It moves beyond simple endpoint sketching to cover resource modeling, lifecycle states, and contract-first documentation for REST, GraphQL, and event-driven systems.

Why use this skill

Designing an API is easy; designing a consistent API that survives internal scaling and public consumption is hard. This skill automates the architectural heavy lifting by enforcing standardized strategies for pagination, error handling, and versioning. Instead of wasting time on debating naming conventions or status codes, the agent applies industry best practices to ensure your contracts are predictable and maintainable.

Supported workflows

• Contract-First Design: Detailed modeling of resources, actions, and request/response shapes before a single line of code is written.
• API Auditing: Comprehensive reviews targeting issue severity, design risks, and backward compatibility evidence.
• Integration Planning: Defining auth boundaries and transport-independent business logic.

The Output

Expect high-density, structured design specs including endpoint summaries, auth expectations, and explicit error behaviors. For reviews, you receive a prioritized list of risks with actionable recommended fixes, ensuring your API remains stable and developer-friendly.