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

Class AddressControllerImpl

java.lang.Object

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

All Implemented Interfaces:

AddressController

@RestController
@RequestMapping("/address")
public class AddressControllerImpl
extends Object
implements AddressController

Controladora REST para gerenciar o endereçamento. Esta classe roteia as requisições HTTP relacionadas a endereço que chegam em "/address" para o serviço correspondente. Implementa a interface AddressController.

Esta classe contém: uma instância de AddressEntityService que é usada para acessar o serviço correspondente à entidade de endereços.

Since:

1.2.0

Author:

diegoneves

See Also:

• AddressEntityService

Field Summary

Fields

Modifier and Type	Field	Description
private final AddressEntityService	addressEntityService

Constructor Summary

Constructors

Constructor	Description
AddressControllerImpl(AddressEntityService addressEntityService)

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<AddressApiResponseDTO>	retrieveAddress(String zipcode)	Obtém um dado Endereço, fazendo uso de um serviço externo. Este é um método HTTP GET que é mapeado para o seguinte URL: /{zipcode}.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

addressEntityService

private final AddressEntityService addressEntityService

Constructor Details

AddressControllerImpl

@Autowired
public AddressControllerImpl(AddressEntityService addressEntityService)

Method Details

retrieveAddress

public org.springframework.http.ResponseEntity<AddressApiResponseDTO> retrieveAddress(String zipcode)

Description copied from interface: AddressController

Obtém um dado Endereço, fazendo uso de um serviço externo.

Este é um método HTTP GET que é mapeado para o seguinte URL: /{zipcode}. Ele usa a anotação @Operation para fornecer uma descrição de alto nível da operação e a anotação @ApiResponses para descrever as possíveis respostas da operação.

Specified by:

retrieveAddress in interface AddressController

Parameters:

zipcode - O código postal do local para o qual se quer obter a informação do endereço. É um valor obrigatório e é informado na URL.

Returns:

ResponseEntity<AddressApiResponseDTO> O objeto AddressApiResponseDTO encapsulado em um ResponseEntity. O objeto AddressApiResponse contém informações detalhadas sobre o endereço. O ResponseEntity é uma extensão do HttpEntity que adiciona um código HttpStatus a ele. A ResponseEntity retorna o endereço obtido com sucesso!

See Also:

• AddressApiResponseDTO