api/dev.akif.crud.simple/SimpleController

SimpleController

abstract class SimpleController<I : Serializable, E : SimpleEntity<I, E>, M : SimpleModel<I>, D : SimpleDTO<I>, out Mapper : SimpleMapper<I, E, M, D>, out S : SimpleService<I, E, M, D, Mapper>>(typeName: String, service: S, mapper: Mapper) : CRUDController<I, E, M, D, M, M, D, D, Mapper, Mapper, S> (source)

Simple variant of CRUDController where create/update models are just models and create/update DTOs are just DTOs

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

Parameters

I

Id type of the data

E

Entity type of the data which is a SimpleEntity

M

Model type of the data which is a SimpleModel

D

DTO type of the data which is a SimpleDTO

Mapper

Mapper type of the data which is a SimpleMapper

S

Service type of the data which is a SimpleService

Constructors

SimpleController

fun <out Mapper : SimpleMapper<I, E, M, D>, out S : SimpleService<I, E, M, D, Mapper>> SimpleController(typeName: String, service: S, mapper: Mapper)

Inherited functions

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

@ResponseStatus(code = HttpStatus.CREATED)

fun create(@RequestBody createDTO: D): D

Default implementation for creating a new entity from given create DTO

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

@ResponseStatus(value = HttpStatus.NO_CONTENT)

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

Default implementation for deleting an entity with given id

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

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

Default implementation for getting an entity with given id

@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

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

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

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