routes-and-naming

What problem does it solve?

This Skill addresses the challenge of creating intuitive, maintainable, and developer-friendly API endpoints by establishing clear conventions for URL structure, resource naming, and field naming.

Core Features & Use Cases

• API Route Design: Guides the creation of logical and hierarchical URL structures.
• Naming Conventions: Enforces consistent naming for resources, fields, and parameters (e.g., snake_case, kebab-case).
• Parameter Usage: Differentiates between path and query parameters for clarity and functionality.
• Use Case: When designing a new set of API endpoints for a user management system, use this Skill to ensure all routes like /users, /users/{id}/orders, and parameters like sort_by follow established best practices, making the API easy to understand and integrate with.

Quick Start

Use the routes-and-naming skill to design the API endpoints for managing user profiles and their associated settings.