task_auto_plan/README.md

1.6 KiB

Demo Spring Boot Project

项目说明

本项目是一个使用 Spring Boot 3.x + Java 17 构建的单体后端工程,集成了 Knife4j (Swagger/OpenAPI) 用于接口文档展示。

技术栈

  • Java 17
  • Spring Boot 3.2.4
  • Knife4j 4.5.0 (OpenAPI 3)
  • Maven
  • Lombok

业务说明

  • 当前所有业务数据使用内存假数据,未接入任何数据库或外部基础设施。
  • 已预留 Repository 接口层扩展点,后续可对接数据库实现。

启动方式

# 编译
mvn clean package

# 运行
mvn spring-boot:run

# 或直接运行生成的 jar
java -jar target/demo-0.0.1-SNAPSHOT.jar

接口文档访问

启动后,打开浏览器访问:

项目结构

src/main/java/com/example/demo/
├── DemoApplication.java          # 启动类
├── config/
│   └── OpenApiConfig.java        # Knife4j/Swagger 配置
├── controller/
│   ├── HealthController.java     # 健康检查接口
│   └── BusinessController.java   # 业务 REST 接口
├── model/
│   └── BusinessItem.java         # 业务数据模型
└── service/
    └── BusinessService.java      # 业务逻辑(内存假数据)

扩展说明

  • repository/ 目录可扩展为数据库 Repository 层
  • service/ 中注入 Repository 即可切换为真实数据源
  • 配置文件已预留 Spring Data JPA / MyBatis 相关配置注释