daruan-rst/magicalpotionbrewery

magicalpotionbrewery's Issues

Sugestões

• Usar DTOs no lugar de DAOs nos controllers (tanto para request, quanto para response se fizer sentido). Você também criou uns objetos de Request, mas poderia adicionar Annotations para validar os campos (notBlank, notNull, Min, Max, JsonFormat, etc...)

• Quando usamos v1/ num endpoint, geralmente usamos ele antes do domain, pois é o versionamento da API ou do endpoint.
  Exemplo: No lugar de /api/ingredient/v1 costumamos usar v1/api/ingredient ou api/v1/ingredient (talvez nem seja necessário usar api aqui).

• No WizardService, você está usando diretamente ingredientRepository, recipeIngredientRepository, recipeRepository e potionRepository. Isso não é recomendado segundo o Single Responsibility Principle (S do SOLID) pois várias classes de Service poderiam alterar dados da mesma entidade no banco de dados, o que pode dificultar manutenção do código e troubleshooting.

• Em Kotlin, no lugar de usar assim:

if (potion == null) {
    throw RequiredObjectIsNullException()
}

Da para usar diretamente:

potion?: throw RequiredObjectIsNullException()

• Outro uso comum em Kotlin é de forEach com listas / collections no lugar de:

for (wizard in wizards) {
     val withSelfRel = linkTo(WizardController::class.java).slash(wizard.id).withSelfRel()
     wizard.add(withSelfRel)
}

Da para usar assim:

wizards.forEach {
      it.add(linkTo(WizardController::class.java).slash(it.id).withSelfRel())
}

• Na classe RecipeIngredientRepository não me parece que era necessário receber o objeto Ingredient inteiro para fazer a consulta, só o nome do ingredient (se único) ou o id deveria ser suficiente e tornaria o código mais simples.

• Adicionar uns Dockerfile e docker-compose.yaml para subir o projeto e o banco de dados já populado para testar.