Package dev.karlkadak.backend.controller

Class CityController

java.lang.Object

dev.karlkadak.backend.controller.CityController

@RestController
@RequestMapping("${api.prefix}/cities")
public class CityController
extends Object

REST controller for interacting with the city database

Field Summary

Fields

Modifier and Type	Field	Description
private final CityManager	cityManager
private final CityRepository	cityRepository
private final WeatherDataRepository	weatherDataRepository

Constructor Summary

Constructors

Constructor	Description
CityController(CityRepository cityRepository, CityManager cityManager, WeatherDataRepository weatherDataRepository)

Method Summary

Modifier and Type	Method	Description
(package private) org.springframework.http.ResponseEntity<List<CityResponse>>	all()	API endpoint for retrieving information about all City objects for which data collection is enabled
(package private) org.springframework.http.ResponseEntity<Void>	disable(Long id)	API endpoint for disabling weather data tracking for a City object
(package private) org.springframework.http.ResponseEntity<CityResponse>	enable(AddCityRequest addCityRequest)	API endpoint for adding and / or enabling weather data tracking for a City object
(package private) org.springframework.http.ResponseEntity<CityResponse>	one(Long id)	API endpoint for retrieving information about a single City object
(package private) org.springframework.http.ResponseEntity<WeatherResponse>	weather(Long id)	API endpoint for requesting the most recent weather data linked to a City object

Methods inherited from class java.lang.Object

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

Field Details

cityRepository

private final CityRepository cityRepository

cityManager

private final CityManager cityManager

weatherDataRepository

private final WeatherDataRepository weatherDataRepository

Constructor Details

CityController

@Autowired
public CityController(CityRepository cityRepository,
 CityManager cityManager,
 WeatherDataRepository weatherDataRepository)

Method Details

all

@GetMapping
org.springframework.http.ResponseEntity<List<CityResponse>> all()

API endpoint for retrieving information about all City objects for which data collection is enabled

Returns:

list of CityResponse objects representing all City objects for which data collection is enabled

enable

@PostMapping
org.springframework.http.ResponseEntity<CityResponse> enable(@RequestBody
 AddCityRequest addCityRequest)

API endpoint for adding and / or enabling weather data tracking for a City object

Parameters:

addCityRequest - request body (city name)

Returns:

a CityResponse object representing the added / enabled City object

one

@GetMapping("/{id}")
org.springframework.http.ResponseEntity<CityResponse> one(@PathVariable
 Long id)

API endpoint for retrieving information about a single City object

Parameters:

id - the City object's id

Returns:

a CityResponse object representing the selected City object

disable

@DeleteMapping("/{id}")
org.springframework.http.ResponseEntity<Void> disable(@PathVariable
 Long id)

API endpoint for disabling weather data tracking for a City object

Parameters:

id - the City object's id

Returns:

an empty ResponseEntity

weather

@GetMapping("/{id}/weather")
org.springframework.http.ResponseEntity<WeatherResponse> weather(@PathVariable
 Long id)

API endpoint for requesting the most recent weather data linked to a City object

Parameters:

id - the City object's id

Returns:

the DTO of latest recorded WeatherData object