What problem does it solve?
Transforms domain models and requirement documents into concrete, standardized API interface contracts so engineering teams can implement consistent endpoints, DTOs, and error handling without design ambiguity.
Core Features & Use Cases
- Endpoint & Resource Design: Extract resources from domain models and map CRUD and non-CRUD actions to RESTful or GraphQL endpoints with naming and idempotency rules.
- DTO & Contract Scaffolding: Produce request/response DTO structures, pagination and list patterns, and TypeScript/Java interface examples organized by module.
- Spec & Validation Artifacts: Generate OpenAPI YAML, error code catalogs, versioning strategy, mermaid design diagrams, and contract test case checklists for consumer-provider verification.
- Use Case: Ideal for backend teams designing new services, refactoring public APIs, or producing importable OpenAPI specs for API gateways and documentation.
Quick Start
Use the api-contract-design skill to generate an OpenAPI YAML, DTO definitions, and an endpoint table from the provided domain model and requirements.