api/dev.akif.crud/CRUDController

CRUDController

@Validated

abstract class CRUDController<I : Serializable, E : CRUDEntity<I, E>, M : CRUDModel<I>, out D : CRUDDTO<I>, CM : CRUDCreateModel, UM : CRUDUpdateModel, in CD : CRUDCreateDTO, in UD : CRUDUpdateDTO, out Mapper : CRUDMapper<I, E, M, CM, UM>, out DTOMapper : CRUDDTOMapper<I, M, D, CM, UM, CD, UD>, out S : CRUDService<I, E, M, CM, UM, Mapper>>(typeName: String, service: S, mapper: DTOMapper)(source)

Base implementation of a controller for API layer providing CRUD operations

For some Foo data that have Long ids, a FooController defined as

@RestController
@RequestMapping("/foo")
class FooController(
    service: FooService,
    dtoMapper: FooDTOMapper
) : CRUDController<
        Long,
        FooDTO,
        Foo,
        FooEntity,
        CreateFoo,
        UpdateFoo,
        CreateFooDTO,
        UpdateFooDTO,
        FooMapper,
        FooDTOMapper,
        FooService>("Foo", service, dtoMapper)

automatically implements

@PostMapping("/")
fun create(createDTO: CreateFooDTO): FooDTO

@GetMapping("/")
fun getAll(page: Int, perPage: Int): Paged<FooDTO>

@GetMapping("/{id}")
fun get(id: Long): FooDTO

@PutMapping("/{id}")
fun update(id: Long, updateDTO: UpdateFooDTO): FooDTO

@DeleteMapping("/{id}")
fun delete(id: Long)

This is meant to be extended from a @RestController class, ideally also with a @RequestMapping with some path prefix for the endpoints.

Parameters

Id type of the data

Entity type of the data which is a CRUDEntity

Model type of the data which is a CRUDModel

DTO type of the data which is a CRUDDTO

Create model type of the data which is a CRUDCreateModel

Update model type of the data which is a CRUDUpdateModel

Create DTO type of the data which is a CRUDCreateDTO

Update DTO type of the data which is a CRUDUpdateDTO

Mapper

Mapper type of the data which is a CRUDMapper

DTOMapper

DTO mapper type of the data which is a CRUDDTOMapper

Service type of the data which is a CRUDService

Constructors

CRUDController

fun <out DTOMapper : CRUDDTOMapper<I, M, D, CM, UM, CD, UD>, out S : CRUDService<I, E, M, CM, UM, Mapper>> CRUDController(typeName: String, service: S, mapper: DTOMapper)

Functions

create

@PostMapping(consumes = ["application/json"], produces = ["application/json"])

@ResponseStatus(code = HttpStatus.CREATED)

fun create(@RequestBody createDTO: CD): D

Default implementation for creating a new entity from given create DTO

delete

@DeleteMapping(value = ["/{id}"])

@ResponseStatus(value = HttpStatus.NO_CONTENT)

fun delete(@PathVariable(value = "id") id: I)

Default implementation for deleting an entity with given id

get

@GetMapping(path = ["/{id}"], produces = ["application/json"])

fun get(@PathVariable(value = "id") id: I): D

Default implementation for getting an entity with given id

getAll

@GetMapping(produces = ["application/json"])

fun getAll(@RequestParam(name = "page", required = false, defaultValue = "0") page: Int, @RequestParam(name = "perPage", required = false, defaultValue = "20") perPage: Int): Paged<D>

Default implementation for listing entities with given pagination

update

@PutMapping(path = ["/{id}"], consumes = ["application/json"], produces = ["application/json"])

fun update(@PathVariable(value = "id") id: I, @RequestBody updateDTO: UD): D

Default implementation for updating an entity with given id with given update DTO data

Inheritors

SimpleController

SimplerController

SimplestController