project-naming-conventions

Use lowercase hyphenated plural resource paths like /users/{userId}, and derive operationId mechanically from the path plus HTTP method, such as usersUserIdGet for GET /users/{userId}. The controller handler method name must exactly match the operationId.

Use UpperCamelCase with role suffixes reflecting actual responsibility: UserController, UserService, UserRepository, UserEntity, UserTO, UserDomain, UserRestMapper. Avoid generic suffixes like Manager, Helper, or Processor when a specific responsibility can be named.

Treat any name consumed outside one compilation unit as a contract migration. Inventory consumers, use compatibility mechanisms like aliases or expand-and-contract migrations, define removal criteria, and verify mixed-version deployments before removing the old name.

No. Physical infrastructure names such as cloud resources, IAM roles, buckets, and Kubernetes objects are deferred to the repository's approved platform or DevOps naming standard. Application code should reference them through typed configuration properties named by purpose.

Use canonical lowercase kebab-case grouped by subsystem, such as clients.catalog.read-timeout, and bind them to a @ConfigurationProperties type. Derive environment variables by replacing dots with underscores, removing dashes, and uppercasing.

Use Micrometer lowercase dot notation for meter names like orders.created, with bounded tag keys and values. Never embed user IDs, emails, or unbounded values in metric names, span names, or tags; use route templates instead of concrete paths.