Skip to content

Commit

Permalink
extended documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
melistik committed Feb 6, 2019
1 parent 8fc2c68 commit 1b3a1af
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Conversion between each object can be automatically generated with [mapstruct](h

**Features:**
* basic DTOs as per example a missing PageableResult
* custom RunetimeExceptions and ExceptionHandler (also for BeanValidationExceptions)
* custom RuntimeExceptions, ExceptionHandler and BeanValidationExceptions
* abstract CRUD controller also for parent child situations
* abstract CRUD resources to consume REST-Services
* prodivded a [project and service generator](https://github.com/rocketbase-io/generator-spring-rest-commons) via yeoman
Expand All @@ -30,6 +30,20 @@ This module provides some useful runtime exceptions like NotFoundException and b

Containing ExceptionHandlers for common errors like BeanValidationExceptions or the custom NotFoundException. Abstract classes to implement CRUD SpringRestController. Also a parent child solution is provided.

### configuration

This module uses the auto configuration feature of spring-boot-starter so that all necessary beans will get configured automatically.
Nevertheless you can customize the configuration by the following properties

| property | default | explanation |
| ------------------------------ | --------------- | ------------------------------------------------------------ |
| locale.resolver.enabled | true | enable/disable default configuration of the LocaleResolver |
| locale.resolver.default | en | |
| handler.badRequest.enabled | true | enable/disable ExceptionHandler for BadRequestException |
| handler.notFound.enabled | true | enable/disable ExceptionHandler for NotFoundException |
| handler.beanValidation.enabled | true | enable/disable ExceptionHandler for MethodArgumentNotValidException (bean validation issues from spring-boot) |


## commons-rest-sample

Sample spring-boot application to demonstrate the use of the provided commons-rest libraries.
Expand Down

0 comments on commit 1b3a1af

Please sign in to comment.