Controller design rules

Overview

This document defines rules for designing REST controllers with consistent URL patterns, response formatting, and search conventions.

Key Principle: All API paths start with /api/v1/, use kebab-case and plural nouns, and always return ApiResource.

URL design

Base path

IMPORTANT: Start all API paths with /api/v1/.

// Good
@RequestMapping("/api/v1/users")
@RequestMapping("/api/v1/order-items")