api/dev.akif.crud.simplest/SimplestController

SimplestController

abstract class SimplestController<I : Serializable, E : SimplestEntity<I>, out Mapper : SimplestMapper<I, E>, out R : SimplestRepository<I, E>, out S : SimplestService<I, E, R, Mapper>>(typeName: String, service: S, mapper: Mapper) : CRUDController<I, E, E, E, E, E, E, E, Mapper, Mapper, R, S> (source)

The simplest variant of CRUDController where the only data model is the entity

This variant is only recommended for very simple data models. Whenever possible, try and use one of the other variants.

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 SimplestEntity

Mapper

Mapper type of the data which is a SimplestMapper

Repository type of the data which is a SimplestRepository

Service type of the data which is a SimplestService

Constructors

SimplestController

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: E, @PathVariable pathVariables: Map<String, String>, request: HttpServletRequest): E

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): E

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<E>

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: E, @PathVariable pathVariables: Map<String, String>, request: HttpServletRequest): E

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