# spring-guides/tut-rest architecture

> Architecture diagram of the GitHub repository spring-guides/tut-rest, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-02). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/spring-guides/tut-rest
- Repository: https://github.com/spring-guides/tut-rest

## Overview

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: [`links/src/main/java/payroll/OrderController.java`](https://github.com/spring-guides/tut-rest/blob/main/links/src/main/java/payroll/OrderController.java) (Order lifecycle API), [`links/src/main/java/payroll/EmployeeController.java`](https://github.com/spring-guides/tut-rest/blob/main/links/src/main/java/payroll/EmployeeController.java) (Employee API), [`links/src/main/java/payroll/EmployeeRepository.java`](https://github.com/spring-guides/tut-rest/blob/main/links/src/main/java/payroll/EmployeeRepository.java) (Employee repository), [`links/src/main/java/payroll/OrderRepository.java`](https://github.com/spring-guides/tut-rest/blob/main/links/src/main/java/payroll/OrderRepository.java) (Order repository)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_foundation["Plain CRUD"]
  node_nonrest_api["Employee API"]
  node_nonrest_repo["Employee repository"]
  node_nonrest_employee["Employee entity<br/>[Employee.java]"]
end

subgraph group_rest["REST resources"]
  node_rest_api["Employee REST API"]
  node_rest_repo["Employee repository"]
  node_rest_employee["Employee entity<br/>[Employee.java]"]
end

subgraph group_hateoas["Hypermedia evolution"]
  node_evolution_api["Assembled employee API"]
  node_evolution_assembler["Employee link assembler"]
  node_evolution_repo["Employee repository"]
  node_evolution_employee["Employee entity<br/>[Employee.java]"]
end

subgraph group_final["Linked payroll"]
  node_root["API entry links"]
  node_employee_api["Employee API"]
  node_employee_assembler["Employee link assembler"]
  node_employee_repo["Employee repository"]
  node_employee["Employee entity<br/>[Employee.java]"]
  node_order_api["Order lifecycle API"]
  node_order_assembler["Order link assembler"]
  node_order_repo["Order repository"]
  node_order["Order entity<br/>[Order.java]"]
  node_status["Order status<br/>[Status.java]"]
  node_seed["Sample data loader<br/>[LoadDatabase.java]"]
  node_app["Spring Boot app"]
end

node_client(("API client"))
node_store[("H2 database")]

node_client -->|"requests CRUD"| node_nonrest_api
node_nonrest_api -->|"calls"| node_nonrest_repo
node_nonrest_repo -->|"stores entities"| node_nonrest_employee
node_client -->|"requests REST"| node_rest_api
node_rest_api -->|"calls"| node_rest_repo
node_rest_repo -->|"stores entities"| node_rest_employee
node_client -->|"requests resources"| node_evolution_api
node_evolution_api -->|"calls"| node_evolution_repo
node_evolution_api -->|"assembles models"| node_evolution_assembler
node_evolution_repo -->|"stores entities"| node_evolution_employee
node_client -->|"requests entry links"| node_root
node_root -->|"links to"| node_employee_api
node_root -->|"links to"| node_order_api
node_client -->|"requests employees"| node_employee_api
node_employee_api -->|"calls"| node_employee_repo
node_employee_api -->|"assembles models"| node_employee_assembler
node_employee_repo -->|"stores entities"| node_employee
node_client -->|"requests orders"| node_order_api
node_order_api -->|"calls"| node_order_repo
node_order_api -->|"assembles models"| node_order_assembler
node_order_api -->|"checks and updates"| node_status
node_order_repo -->|"stores entities"| node_order
node_order_assembler -->|"embeds entity"| node_order
node_order_assembler -->|"checks state"| node_status
node_seed -->|"preloads employees"| node_employee_repo
node_seed -->|"preloads orders"| node_order_repo
node_app -.->|"runs at startup"| node_seed
node_employee_repo -.->|"persists through JPA"| node_store
node_order_repo -.->|"persists through JPA"| node_store

click node_nonrest_api "https://github.com/spring-guides/tut-rest/blob/main/nonrest/src/main/java/payroll/EmployeeController.java"
click node_nonrest_repo "https://github.com/spring-guides/tut-rest/blob/main/nonrest/src/main/java/payroll/EmployeeRepository.java"
click node_nonrest_employee "https://github.com/spring-guides/tut-rest/blob/main/nonrest/src/main/java/payroll/Employee.java"
click node_rest_api "https://github.com/spring-guides/tut-rest/blob/main/rest/src/main/java/payroll/EmployeeController.java"
click node_rest_repo "https://github.com/spring-guides/tut-rest/blob/main/rest/src/main/java/payroll/EmployeeRepository.java"
click node_rest_employee "https://github.com/spring-guides/tut-rest/blob/main/rest/src/main/java/payroll/Employee.java"
click node_evolution_api "https://github.com/spring-guides/tut-rest/blob/main/evolution/src/main/java/payroll/EmployeeController.java"
click node_evolution_assembler "https://github.com/spring-guides/tut-rest/blob/main/evolution/src/main/java/payroll/EmployeeModelAssembler.java"
click node_evolution_repo "https://github.com/spring-guides/tut-rest/blob/main/evolution/src/main/java/payroll/EmployeeRepository.java"
click node_evolution_employee "https://github.com/spring-guides/tut-rest/blob/main/evolution/src/main/java/payroll/Employee.java"
click node_root "https://github.com/spring-guides/tut-rest/blob/main/links/src/main/java/payroll/RootController.java"
click node_employee_api "https://github.com/spring-guides/tut-rest/blob/main/links/src/main/java/payroll/EmployeeController.java"
click node_employee_assembler "https://github.com/spring-guides/tut-rest/blob/main/links/src/main/java/payroll/EmployeeModelAssembler.java"
click node_employee_repo "https://github.com/spring-guides/tut-rest/blob/main/links/src/main/java/payroll/EmployeeRepository.java"
click node_employee "https://github.com/spring-guides/tut-rest/blob/main/links/src/main/java/payroll/Employee.java"
click node_order_api "https://github.com/spring-guides/tut-rest/blob/main/links/src/main/java/payroll/OrderController.java"
click node_order_assembler "https://github.com/spring-guides/tut-rest/blob/main/links/src/main/java/payroll/OrderModelAssembler.java"
click node_order_repo "https://github.com/spring-guides/tut-rest/blob/main/links/src/main/java/payroll/OrderRepository.java"
click node_order "https://github.com/spring-guides/tut-rest/blob/main/links/src/main/java/payroll/Order.java"
click node_status "https://github.com/spring-guides/tut-rest/blob/main/links/src/main/java/payroll/Status.java"
click node_seed "https://github.com/spring-guides/tut-rest/blob/main/links/src/main/java/payroll/LoadDatabase.java"
click node_app "https://github.com/spring-guides/tut-rest/blob/main/links/src/main/java/payroll/PayrollApplication.java"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_nonrest_api,node_nonrest_repo,node_nonrest_employee,node_client toneBlue
class node_rest_api,node_rest_repo,node_rest_employee,node_store toneAmber
class node_evolution_api,node_evolution_assembler,node_evolution_repo,node_evolution_employee toneMint
class node_root,node_employee_api,node_employee_assembler,node_employee_repo,node_employee,node_order_api,node_order_assembler,node_order_repo,node_order,node_status,node_seed,node_app toneRose
```

## Components

### Plain CRUD

- [Employee API](https://github.com/spring-guides/tut-rest/blob/main/nonrest/src/main/java/payroll/EmployeeController.java): `nonrest/src/main/java/payroll/EmployeeController.java`
- [Employee repository](https://github.com/spring-guides/tut-rest/blob/main/nonrest/src/main/java/payroll/EmployeeRepository.java): `nonrest/src/main/java/payroll/EmployeeRepository.java`
- [Employee entity](https://github.com/spring-guides/tut-rest/blob/main/nonrest/src/main/java/payroll/Employee.java): `nonrest/src/main/java/payroll/Employee.java`

### REST resources

- [Employee REST API](https://github.com/spring-guides/tut-rest/blob/main/rest/src/main/java/payroll/EmployeeController.java): `rest/src/main/java/payroll/EmployeeController.java`
- [Employee repository](https://github.com/spring-guides/tut-rest/blob/main/rest/src/main/java/payroll/EmployeeRepository.java): `rest/src/main/java/payroll/EmployeeRepository.java`
- [Employee entity](https://github.com/spring-guides/tut-rest/blob/main/rest/src/main/java/payroll/Employee.java): `rest/src/main/java/payroll/Employee.java`

### Hypermedia evolution

- [Assembled employee API](https://github.com/spring-guides/tut-rest/blob/main/evolution/src/main/java/payroll/EmployeeController.java): `evolution/src/main/java/payroll/EmployeeController.java`
- [Employee link assembler](https://github.com/spring-guides/tut-rest/blob/main/evolution/src/main/java/payroll/EmployeeModelAssembler.java): `evolution/src/main/java/payroll/EmployeeModelAssembler.java`
- [Employee repository](https://github.com/spring-guides/tut-rest/blob/main/evolution/src/main/java/payroll/EmployeeRepository.java): `evolution/src/main/java/payroll/EmployeeRepository.java`
- [Employee entity](https://github.com/spring-guides/tut-rest/blob/main/evolution/src/main/java/payroll/Employee.java): `evolution/src/main/java/payroll/Employee.java`

### Linked payroll

- [API entry links](https://github.com/spring-guides/tut-rest/blob/main/links/src/main/java/payroll/RootController.java): `links/src/main/java/payroll/RootController.java`
- [Employee API](https://github.com/spring-guides/tut-rest/blob/main/links/src/main/java/payroll/EmployeeController.java): `links/src/main/java/payroll/EmployeeController.java`
- [Employee link assembler](https://github.com/spring-guides/tut-rest/blob/main/links/src/main/java/payroll/EmployeeModelAssembler.java): `links/src/main/java/payroll/EmployeeModelAssembler.java`
- [Employee repository](https://github.com/spring-guides/tut-rest/blob/main/links/src/main/java/payroll/EmployeeRepository.java): `links/src/main/java/payroll/EmployeeRepository.java`
- [Employee entity](https://github.com/spring-guides/tut-rest/blob/main/links/src/main/java/payroll/Employee.java): `links/src/main/java/payroll/Employee.java`
- [Order lifecycle API](https://github.com/spring-guides/tut-rest/blob/main/links/src/main/java/payroll/OrderController.java): `links/src/main/java/payroll/OrderController.java`
- [Order link assembler](https://github.com/spring-guides/tut-rest/blob/main/links/src/main/java/payroll/OrderModelAssembler.java): `links/src/main/java/payroll/OrderModelAssembler.java`
- [Order repository](https://github.com/spring-guides/tut-rest/blob/main/links/src/main/java/payroll/OrderRepository.java): `links/src/main/java/payroll/OrderRepository.java`
- [Order entity](https://github.com/spring-guides/tut-rest/blob/main/links/src/main/java/payroll/Order.java): `links/src/main/java/payroll/Order.java`
- [Order status](https://github.com/spring-guides/tut-rest/blob/main/links/src/main/java/payroll/Status.java): `links/src/main/java/payroll/Status.java`
- [Sample data loader](https://github.com/spring-guides/tut-rest/blob/main/links/src/main/java/payroll/LoadDatabase.java): `links/src/main/java/payroll/LoadDatabase.java`
- [Spring Boot app](https://github.com/spring-guides/tut-rest/blob/main/links/src/main/java/payroll/PayrollApplication.java): `links/src/main/java/payroll/PayrollApplication.java`

### Other components

- **API client**
- **H2 database**

## Connections

- API client → Employee API: requests CRUD (evidence: `README.adoc`)
- Employee API → Employee repository: calls (evidence: `nonrest/src/main/java/payroll/EmployeeController.java`)
- Employee repository → Employee entity: stores entities (evidence: `README.adoc`)
- API client → Employee REST API: requests REST (evidence: `README.adoc`)
- Employee REST API → Employee repository: calls (evidence: `rest/src/main/java/payroll/EmployeeController.java`)
- Employee repository → Employee entity: stores entities (evidence: `README.adoc`)
- API client → Assembled employee API: requests resources (evidence: `README.adoc`)
- Assembled employee API → Employee repository: calls (evidence: `evolution/src/main/java/payroll/EmployeeController.java`)
- Assembled employee API → Employee link assembler: assembles models (evidence: `evolution/src/main/java/payroll/EmployeeController.java`)
- Employee repository → Employee entity: stores entities (evidence: `README.adoc`)
- API client → API entry links: requests entry links (evidence: `links/src/main/java/payroll/RootController.java`)
- API entry links → Employee API: links to (evidence: `links/src/main/java/payroll/RootController.java`)
- API entry links → Order lifecycle API: links to (evidence: `links/src/main/java/payroll/RootController.java`)
- API client → Employee API: requests employees (evidence: `links/src/main/java/payroll/EmployeeController.java`)
- Employee API → Employee repository: calls (evidence: `links/src/main/java/payroll/EmployeeController.java`)
- Employee API → Employee link assembler: assembles models (evidence: `links/src/main/java/payroll/EmployeeController.java`)
- Employee repository → Employee entity: stores entities (evidence: `README.adoc`)
- API client → Order lifecycle API: requests orders (evidence: `links/src/main/java/payroll/OrderController.java`)
- Order lifecycle API → Order repository: calls (evidence: `links/src/main/java/payroll/OrderController.java`)
- Order lifecycle API → Order link assembler: assembles models (evidence: `links/src/main/java/payroll/OrderController.java`)
- Order lifecycle API → Order status: checks and updates (evidence: `links/src/main/java/payroll/OrderController.java`)
- Order repository → Order entity: stores entities (evidence: `links/src/main/java/payroll/OrderRepository.java`)
- Order link assembler → Order entity: embeds entity (evidence: `links/src/main/java/payroll/OrderModelAssembler.java`)
- Order link assembler → Order status: checks state (evidence: `links/src/main/java/payroll/OrderModelAssembler.java`)
- Sample data loader → Employee repository: preloads employees (evidence: `links/src/main/java/payroll/LoadDatabase.java`)
- Sample data loader → Order repository: preloads orders (evidence: `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
