api/dev.akif.crud.simple/SimpleController

SimpleController

abstract class SimpleController<I : Serializable, E : SimpleEntity<I>, M : SimpleModel<I>, D : SimpleDTO<I>, out Mapper : SimpleMapper<I, E, M, D>, out R : SimpleRepository<I, E>, out S : SimpleService<I, E, M, D, R, Mapper>>(typeName: String, service: S, mapper: Mapper) : CRUDController<I, E, M, D, M, M, D, D, Mapper, Mapper, R, 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

Id type of the data

Entity type of the data which is a SimpleEntity

Model type of the data which is a SimpleModel

DTO type of the data which is a SimpleDTO

Mapper

Mapper type of the data which is a SimpleMapper

Repository type of the data which is a SimpleRepository

Service type of the data which is a SimpleService

Constructors

SimpleController

constructor(typeName: String, service: S, mapper: Mapper)

Inherited functions

create

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

@ResponseStatus(code = HttpStatus.CREATED)

open fun create(@RequestBody createDTO: D, @PathVariable pathVariables: Map<String, String>, request: HttpServletRequest): D

Default implementation for creating a new entity from given create DTO

delete

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

@ResponseStatus(value = HttpStatus.NO_CONTENT)

open fun delete(@PathVariable(value = "id") id: I, @PathVariable pathVariables: Map<String, String>, request: HttpServletRequest)

Default implementation for deleting an entity with given id

get

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

open fun get(@PathVariable(value = "id") id: I, @PathVariable pathVariables: Map<String, String>, request: HttpServletRequest): D

Default implementation for getting an entity with given id

list

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

open fun list(@RequestParam(name = "page", required = false, defaultValue = "0") page: Int, @RequestParam(name = "perPage", required = false, defaultValue = "20") perPage: Int, @PathVariable pathVariables: Map<String, String>, request: HttpServletRequest): Paged<D>

Default implementation for listing entities with given pagination

update

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

open fun update(@PathVariable(value = "id") id: I, @RequestBody updateDTO: D, @PathVariable pathVariables: Map<String, String>, request: HttpServletRequest): D

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