Class DonorDepositControllerImpl

java.lang.Object
diegosneves.github.conectardoacoes.adapters.rest.controller.imp.DonorDepositControllerImpl
All Implemented Interfaces:
DonorDepositController

@RestController @RequestMapping("/deposit") public class DonorDepositControllerImpl extends Object implements DonorDepositController
Controlador REST responsável pelo gerenciamento dos depósitos de doações. Esta classe implementa a interface DonorDepositController e expõe endpoints REST para operações relacionadas aos depósitos de doações.

A classe utiliza o serviço DonorDepositService para realizar as operações de negócio.

Endpoints expostos:

  • POST /deposit - Registra uma nova doação de depósito.
Since:
1.3.0
Author:
diegoneves
See Also:
  • Field Details

  • Constructor Details

  • Method Details

    • registeredDonation

      public org.springframework.http.ResponseEntity<RegisteredDepositResponse> registeredDonation(DepositDonationRequest request)
      Description copied from interface: DonorDepositController
      Endpoint para registrar um item de doação no depósito do Doador.

      Este endpoint recebe uma requisição POST contendo dados do item a ser registrado e armazena essa informação no depósito associado ao doador. A requisição deve conter um JSON com as informações definidas na classe DepositDonationRequest.

      Notas sobre o funcionamento:

      • Anotações @PostMapping definem a rota e especificam o tipo de mídia de consumo e produção (MediaType.APPLICATION_JSON_VALUE para ambos).
      • Anotação @Operation fornece metadados Swagger para documentar a operação de registro do item de doação.
      • Anotação @ApiResponses define as respostas possíveis para esta requisição.
      Specified by:
      registeredDonation in interface DonorDepositController
      Parameters:
      request - objeto do tipo DepositDonationRequest, contendo as informações do item de doação a ser registrado.
      Returns:
      um ResponseEntity contendo uma instância de RegisteredDepositResponse retornada com sucesso, ou um ExceptionDTO em caso de erro.