There are two hard things in Computer Science, and the following is an attempt to ease our pain when naming things.
| What | Naming convention | Example |
|---|---|---|
| microservice | functional description (+service) | A backend service |
| repository | microservice name | a-backend-service |
| api specification | microservice name.yaml | a-backend-service.yaml |
| groupId | no.brreg.servicename | no.brreg.abackendservice |
| artifactId | service-name | a-backend-service |
| package | groupId.funtion | no.brreg.abackendservice.api|controller|service|repository|model |
| Api classes | name-of-resource-in-api-spec+Api | SomeResourceApi.java |
| Model classes | name-of-resource-in-api-spec+DB | SomeResourceDB.java |
| Controller classes | name-of-resource-in-api-spec+ApiImpl.java | SomeResourceApiImpl.java |
| Service classes | name-of-resource-in-api-spec +Service | SomeResourceService.java |
| Repository classes | name-of-resource-in-api-spec +Repository | SomeResourceRepository.java |