controller-design

What problem does it solve?

This Skill ensures consistency and adherence to best practices in RESTful API controller design, leading to more maintainable, understandable, and scalable backend services.

Core Features & Use Cases

• URL Design Conventions: Enforces standardized URL patterns, including versioning, kebab-case, and plural resource names.
• Response Formatting: Mandates the use of ApiResource for consistent API responses.
• Search Endpoint Patterns: Provides guidelines for implementing efficient and maintainable search functionality.
• Use Case: When developing a new microservice, use this Skill to guide the creation of its controllers, ensuring all endpoints follow the established company-wide API standards from the outset.

Quick Start

Apply the controller design rules to ensure all API paths start with /api/v1/, use kebab-case, and plural nouns for resource collections.