Package diegosneves.github.conectardoacoes.adapters.rest.controller.imp

Class UserControllerImpl

java.lang.Object
diegosneves.github.conectardoacoes.adapters.rest.controller.imp.UserControllerImpl
All Implemented Interfaces:
UserController
@RestController @RequestMapping("/user") public class UserControllerImpl extends Object implements UserController
Esta é a classe UserControllerImpl que implementa a interface UserController. É anotada com RestController, o que significa que é um controlador de serviço web em que cada método retorna um objeto de domínio (Entity) ao invés de uma view. É responsável por lidar com todas as requisições HTTP que são enviadas para a URL "/user".

Possui uma instância da classe de serviço UserEntityService, que é usada para implementar a lógica de negócios relacionada aos usuários.

Since:
1.0.0
Author:
diegoneves

  • Field Details

  • Constructor Details

    • UserControllerImpl

      @Autowired public UserControllerImpl(UserEntityService service)

  • Method Details

    • createUser

      public org.springframework.http.ResponseEntity<UserEntityCreatedResponse> createUser(UserEntityCreationRequest request)
      Description copied from interface: UserController
      Este endpoint pertence à aplicação "Usuários". Responsável por registrar novos usuários no sistema. Aceita uma requisição POST com o objeto UserEntityCreationRequest no corpo que contém as informações do usuário a ser registrado.

      Após a criação bem-sucedida do usuário, retorna um objeto ResponseEntity que encapsula os detalhes da criação do usuário na forma de UserEntityCreatedResponse.

      O objeto UserEntityCreatedResponse é um DTO que contém os detalhes relevantes sobre o usuário que foi criado. Isso inclui o ID de usuário único gerado pelo sistema, o nome de usuário escolhido, o endereço de e-mail fornecido e o tipo de perfil associado a este usuário.

      Em qualquer caso de violação das validações de integridade do modelo da entidade, um erro HTTP apropriado é retornado junto com os detalhes do erro.

      Specified by:
      createUser in interface UserController
      Parameters:
      request - um objeto UserEntityCreationRequest encapsulando os detalhes do novo usuário a ser registrado. Este parâmetro deve estar presente no corpo da solicitação POST e é deserializado para o tipo UserEntityCreationRequest.
      Returns:
      ResponseEntity que encapsula o UserEntityCreatedResponse se o usuário for criado com sucesso.
      See Also:

    • findUserByEmail

      public org.springframework.http.ResponseEntity<UserEntityCreatedResponse> findUserByEmail(String email)
      Description copied from interface: UserController
      Este endpoint pertence à aplicação "Usuários". Responsável por encontrar usuários no sistema por meio do email registrado.

      Aceita uma requisição GET com o objeto String email como Path variable na url da requisição que contém o email do usuário registrado.

      Após o usuário ser encontrado, retorna um objeto ResponseEntity que encapsula os detalhes da criação do usuário na forma de UserEntityCreatedResponse.

      O objeto UserEntityCreatedResponse é um DTO que contém os detalhes relevantes sobre o usuário que foi criado. Isso inclui o ID de usuário único gerado pelo sistema, o nome de usuário escolhido, o endereço de e-mail fornecido e o tipo de perfil associado a este usuário.

      Em qualquer caso de violação das validações de integridade do modelo da entidade, um erro HTTP apropriado é retornado junto com os detalhes do erro. Este parâmetro deve estar presente na url da solicitação GET e é deserializado para o tipo UserEntityCreatedResponse.

      Specified by:
      findUserByEmail in interface UserController
      Returns:
      ResponseEntity que encapsula o UserEntityCreatedResponse se o email do usuário for encontrado com sucesso.
      See Also: