How spring-guides/tut-rest works
This repository is a Spring tutorial that builds a payroll service in four successive modules; links is the documented final solution. The main workflow serves employee and order HTTP resources, accesses persisted entities through Spring Data repositories, and returns HATEOAS links. The graph shows the employee API evolving from plain CRUD through REST to assembled hypermedia, then the final linked service’s order lifecycle. README descriptions support the module progression and H2 storage; unsampled module internals are represented conservatively, and the graph does not imply calls between tutorial stages.
Main entry points: OrderController.java Order lifecycle API · EmployeeController.java Employee API · EmployeeRepository.java Employee repository · OrderRepository.java Order repository
Components 24
Plain CRUD
- Employee API
nonrest/src/main/java/payroll/EmployeeController.java - Employee repository
nonrest/src/main/java/payroll/EmployeeRepository.java - Employee entity
nonrest/src/main/java/payroll/Employee.java
REST resources
- Employee REST API
rest/src/main/java/payroll/EmployeeController.java - Employee repository
rest/src/main/java/payroll/EmployeeRepository.java - Employee entity
rest/src/main/java/payroll/Employee.java
Hypermedia evolution
- Assembled employee API
evolution/src/main/java/payroll/EmployeeController.java - Employee link assembler
evolution/src/main/java/payroll/EmployeeModelAssembler.java - Employee repository
evolution/src/main/java/payroll/EmployeeRepository.java - Employee entity
evolution/src/main/java/payroll/Employee.java
Linked payroll
- API entry links
links/src/main/java/payroll/RootController.java - Employee API
links/src/main/java/payroll/EmployeeController.java - Employee link assembler
links/src/main/java/payroll/EmployeeModelAssembler.java - Employee repository
links/src/main/java/payroll/EmployeeRepository.java - Employee entity
links/src/main/java/payroll/Employee.java - Order lifecycle API
links/src/main/java/payroll/OrderController.java - Order link assembler
links/src/main/java/payroll/OrderModelAssembler.java - Order repository
links/src/main/java/payroll/OrderRepository.java - Order entity
links/src/main/java/payroll/Order.java - Order status
links/src/main/java/payroll/Status.java - Sample data loader
links/src/main/java/payroll/LoadDatabase.java - Spring Boot app
links/src/main/java/payroll/PayrollApplication.java
Other components
- API client
- H2 database
Connections 29
- API client → Employee API: requests CRUD
README.adoc - Employee API → Employee repository: calls
nonrest/src/main/java/payroll/EmployeeController.java - Employee repository → Employee entity: stores entities
README.adoc - API client → Employee REST API: requests REST
README.adoc - Employee REST API → Employee repository: calls
rest/src/main/java/payroll/EmployeeController.java - Employee repository → Employee entity: stores entities
README.adoc - API client → Assembled employee API: requests resources
README.adoc - Assembled employee API → Employee repository: calls
evolution/src/main/java/payroll/EmployeeController.java - Assembled employee API → Employee link assembler: assembles models
evolution/src/main/java/payroll/EmployeeController.java - Employee repository → Employee entity: stores entities
README.adoc - API client → API entry links: requests entry links
links/src/main/java/payroll/RootController.java - API entry links → Employee API: links to
links/src/main/java/payroll/RootController.java - API entry links → Order lifecycle API: links to
links/src/main/java/payroll/RootController.java - API client → Employee API: requests employees
links/src/main/java/payroll/EmployeeController.java - Employee API → Employee repository: calls
links/src/main/java/payroll/EmployeeController.java - Employee API → Employee link assembler: assembles models
links/src/main/java/payroll/EmployeeController.java - Employee repository → Employee entity: stores entities
README.adoc - API client → Order lifecycle API: requests orders
links/src/main/java/payroll/OrderController.java - Order lifecycle API → Order repository: calls
links/src/main/java/payroll/OrderController.java - Order lifecycle API → Order link assembler: assembles models
links/src/main/java/payroll/OrderController.java - Order lifecycle API → Order status: checks and updates
links/src/main/java/payroll/OrderController.java - Order repository → Order entity: stores entities
links/src/main/java/payroll/OrderRepository.java - Order link assembler → Order entity: embeds entity
links/src/main/java/payroll/OrderModelAssembler.java - Order link assembler → Order status: checks state
links/src/main/java/payroll/OrderModelAssembler.java - Sample data loader → Employee repository: preloads employees
links/src/main/java/payroll/LoadDatabase.java - Sample data loader → Order repository: preloads orders
links/src/main/java/payroll/LoadDatabase.java - Spring Boot app → Sample data loader: runs at startup
- Employee repository → H2 database: persists through JPA
- Order repository → H2 database: persists through JPA