Initial commit
This commit is contained in:
39
skills/spring-boot-crud-patterns/templates/README.md
Normal file
39
skills/spring-boot-crud-patterns/templates/README.md
Normal file
@@ -0,0 +1,39 @@
|
||||
# CRUD Generator Templates
|
||||
|
||||
You must provide all templates (.tpl) required by the generator; there is no fallback.
|
||||
|
||||
How it works:
|
||||
- The generator loads .tpl files from this directory (or a directory passed via --templates-dir).
|
||||
- It uses Python string.Template placeholders (e.g., $package, $entity, $id_type, $id_name, $id_name_lower, $base_path, $dto_request, $dto_response).
|
||||
- If any template is missing or fails to render, generation fails.
|
||||
|
||||
Required template filenames:
|
||||
- DomainModel.java.tpl
|
||||
- DomainRepository.java.tpl
|
||||
- JpaEntity.java.tpl
|
||||
- SpringDataRepository.java.tpl
|
||||
- PersistenceAdapter.java.tpl
|
||||
- CreateService.java.tpl
|
||||
- GetService.java.tpl
|
||||
- UpdateService.java.tpl
|
||||
- DeleteService.java.tpl
|
||||
- ListService.java.tpl
|
||||
- Mapper.java.tpl
|
||||
- DtoRequest.java.tpl
|
||||
- DtoResponse.java.tpl
|
||||
- PageResponse.java.tpl
|
||||
- ErrorResponse.java.tpl
|
||||
- Controller.java.tpl
|
||||
- GlobalExceptionHandler.java.tpl
|
||||
- EntityExceptionHandler.java.tpl
|
||||
- NotFoundException.java.tpl
|
||||
- ExistException.java.tpl
|
||||
|
||||
Tip: Start simple and expand over time; these files are your team’s baseline.
|
||||
|
||||
Conventions:
|
||||
- Base path is versioned: /v1/{resources}
|
||||
- POST returns 201 Created and sets Location: /v1/{resources}/{id}
|
||||
- GET collection supports pagination via Pageable in controller and returns PageResponse<T>
|
||||
- Application layer uses ${Entity}Mapper for DTO↔Domain and throws ${Entity}ExistException on duplicates
|
||||
- Exceptions are mapped by GlobalExceptionHandler and ${Entity}ExceptionHandler
|
||||
Reference in New Issue
Block a user