[add]docs

This commit is contained in:
many2many 2024-05-08 11:05:59 +08:00
parent 075528a4a5
commit afc16a564c

View File

@ -1,16 +1,14 @@
### 任务名称: 创建spring boot初始项目 ### 任务名称: 创建spring boot初始项目
#### 目标: #### 目标
- 通过spring starter创建一个spring boot项目,选择依赖spring web, h2, mysql, jpa, lombok - 通过spring starter创建一个spring boot项目,选择依赖spring web, h2, mysql, jpa, lombok
- 添加依赖: spring openapi、structmapper - 添加依赖: springdoc openapi
- 添加配置: application.yml, application.properties - 添加配置文件: application.yml
- 配置JPA、H2数据库、spring openapi、logging - 配置JPA、H2数据库、springdoc openapi、logging
- 基于层次架构设计目录结构及java包结构 #### 预备知识
#### 预备知识:
- 项目构建工具gradle - 项目构建工具gradle
- spring boot框架项目结构和配置文件 - spring boot框架项目结构和配置文件
#### 操作步骤: #### 操作步骤
1、使用Spring Initializr创建一个Spring Boot项目。 1、使用Spring Initializr创建一个Spring Boot项目。
在浏览器中访问https://start.spring.io/ 在浏览器中访问https://start.spring.io/
@ -170,20 +168,20 @@ openapi文档访问地址: http://localhost:8080/api-docs
#### 技术/工具需求: #### 技术/工具需求
- intellij idea 社区版 2023 及以上 - intellij idea 社区版 2023 及以上
- gradle 8.5及及上 - gradle 8.5及及上
- spring boot 3.2.3以上 - spring boot 3.2.3以上
- jdk 17 及以上 - jdk 17 及以上
#### 成功标准: #### 成功标准
- [明确完成任务的评判标准,如代码功能实现、性能指标、测试通过条件等。] - [明确完成任务的评判标准,如代码功能实现、性能指标、测试通过条件等。]
#### 扩展学习(可选): #### 扩展学习(可选)
- [提供一些额外学习资源或挑战性任务,鼓励学有余力的学生进一步探索。] - [提供一些额外学习资源或挑战性任务,鼓励学有余力的学生进一步探索。]
#### 评估与反馈: #### 评估与反馈
- [说明如何提交作业、代码审查的标准、或任何反馈收集机制。] - [说明如何提交作业、代码审查的标准、或任何反馈收集机制。]
#### 时间估算: #### 时间估算
- [给出预计完成该任务所需的时间,帮助学生合理安排学习计划。] - [给出预计完成该任务所需的时间,帮助学生合理安排学习计划。]