What problem does it solve?
This Skill helps you turn business requirements into clear API contracts, preventing vague endpoint design, inconsistent responses, and missing standards that slow down implementation.
Core Features & Use Cases
- Resource Modeling: Define resources, relationships, URIs, methods, and response shapes for REST or GraphQL APIs.
- OpenAPI Planning: Create versioned API specifications with schemas, security, pagination, and error handling.
- Architecture Guidance: Establish reusable patterns for deprecation, backward compatibility, validation, and documentation.
- Use Case: When building a backend for a movie ticket booking system, it can help design endpoints for movies, showtimes, seats, bookings, authentication, and rate-limited collection queries.
Quick Start
Use the api-designer skill to design a REST API for my product and return a complete OpenAPI 3.1 specification with versioning, pagination, authentication, and RFC 7807 error responses.