Spring Data JPA Demo

Spring Boot 3.5 · Java 21 · REST Docs

一个能直接跑起来的 Spring Data JPA 示例

从 API 文档、测试到源码结构，都能在这里快速对上。先看接口，再按需深入实现。

查看 API Guide 浏览项目仓库

2 个核心实体

围绕 Dept 与 Employee 展示常见主数据建模、关联和分页查询。

测试驱动文档

REST Docs snippets 来自自动化测试，降低文档与接口实现漂移。

资源导向

通过 Spring Data REST 暴露 HAL 资源，便于观察链接发现与导航方式。

动态查询

使用 JpaSpecificationExecutor 演示分页、排序和条件过滤的典型组合。

工程闭环

测试、文档、数据库迁移与本地运行链路完整，适合直接拿来做练习或模板。

统一入口

首页负责建立上下文，API Guide 负责承载细节，信息分层更清楚。

Overview

这个示例适合怎么用

适合先快速浏览接口，再回到仓库理解测试、实体建模和文档生成方式。无论是学习 Spring Data JPA，还是拿来做脚手架参考，都能直接上手。

先看接口全貌

API Guide 提供资源入口、请求示例和分页结构，方便快速判断项目是否符合预期。

再看测试与文档

REST Docs 片段来自自动化测试，便于理解接口说明和实现如何保持一致。

最后按需扩展

项目已带好 Maven Wrapper、数据库迁移和本地运行链路，适合继续改造成自己的模板。

Included

项目里已经包含的能力

这些内容都能在代码、测试或生成页面里找到对应实现，不只是停留在 README 的描述。

Data access

Spring Data JPA 仓库层

通过 JpaRepository 与 JpaSpecificationExecutor 演示 CRUD、分页、排序和动态查询。

API style

Spring Data REST + HATEOAS

以资源导向方式暴露接口，适合观察 HAL 结构、链接发现和资源导航体验。

Docs as code

测试驱动文档生成

接口说明来自测试片段，再由 AsciiDoctor 汇总成稳定、可浏览的在线文档页面。

Runtime

H2 / Flyway / Actuator

内置数据库迁移、本地演示环境与运行时观测能力，便于快速验证模型和接口行为。

Quality

JaCoCo 覆盖率报告

测试链路同时输出覆盖率结果，帮助示例继续演进成更可维护的真实工程。

Delivery

持续化页面发布

文档页面可以自动构建输出，适合作为项目官网、接口门户与演示入口的统一落点。

Quick start

3 分钟完成本地验证

当前维护基线为 Spring Boot 3.5.13 与 Java 21。

下面这组命令足够完成环境准备、测试和本地启动：

mise install
./mvnw test
./mvnw spring-boot:run

执行 mise install，准备项目要求的 Java 21 环境。
执行 ./mvnw test，生成 REST Docs snippets 与测试结果。
执行 ./mvnw spring-boot:run，本地体验接口和文档页面。