Package dev.akif.crud

package dev.akif.crud

spring-boot-crud is a library that provides opinionated, REST-ful and generic CRUD (Create, Read, Update and Delete) operations on data models in a backend API application using Spring Boot. Its purpose is to eliminate duplication.

It provides

• a controller base type with create, getAll (list with pagination), get, update and delete endpoints
• a service base type with methods corresponding to provided endpoints
• a repository base type to provide data access interface
• DTO (Data Transfer Object) base types for creating, updating and getting to use at API layer
• Model base types for creating, updating and getting to use at service layer
• Entity base type to use at data layer
• Logging at different layers and levels
• OpenAPI documentation with Swagger UI

as long as your data models extend provided base types. You'll be required to provide concrete types to type parameters, provide implementations for a few abstract members, and you'll get all of the above for free.

See

• CRUDController
• CRUDService
• CRUDRepository
• BaseDTO
• BaseModel
• BaseEntity

Class	Description
BaseCreateDTO<I extends Serializable,M extends BaseModel<I>,E extends BaseEntity<I,M>,CM extends BaseCreateModel<I,M,E>>	Base DTO that contains required data to create a new entity
BaseCreateModel<I extends Serializable,M extends BaseModel<I>,E extends BaseEntity<I,M>>	Base model that contains required data to create a new entity
BaseDTO<I extends Serializable>	Base DTO of an entity
BaseEntity<I extends Serializable,M extends BaseModel<I>>	Base entity of a data model representing its persisted structure
BaseModel<I extends Serializable>	Base model of a data model
BaseUpdateDTO<I extends Serializable,M extends BaseModel<I>,E extends BaseEntity<I,M>,UM extends BaseUpdateModel<I,M,E>>	Base DTO that contains required data to update an existing entity
BaseUpdateModel<I extends Serializable,M extends BaseModel<I>,E extends BaseEntity<I,M>>	Base model that contains required data to update an existing entity
CRUDController<I extends Serializable,D extends BaseDTO<I>,M extends BaseModel<I>,E extends BaseEntity<I,M>,CM extends BaseCreateModel<I,M,E>,UM extends BaseUpdateModel<I,M,E>,CD extends BaseCreateDTO<I,M,E,CM>,UD extends BaseUpdateDTO<I,M,E,UM>,R extends CRUDRepository<I,M,E>,S extends CRUDService<I,M,E,CM,UM,R>>	Base implementation of a CRUD controller for API layer
CRUDError	Error model of the API operations
CRUDErrorException	Wrapper for a CRUDError as a RuntimeException so it can be thrown
CRUDErrorHandler	Default ExceptionHandler implementation for CRUDErrorException
CRUDRepository<I extends Serializable,M extends BaseModel<I>,E extends BaseEntity<I,M>>	Base interface of a CRUD repository for data layer
CRUDService<I extends Serializable,M extends BaseModel<I>,E extends BaseEntity<I,M>,CM extends BaseCreateModel<I,M,E>,UM extends BaseUpdateModel<I,M,E>,R extends CRUDRepository<I,M,E>>	Base implementation of a CRUD service for business layer
Paged<A>	Container of paged data with its pagination info