[add]docs

This commit is contained in:
many2many 2024-05-08 11:03:40 +08:00
parent 1d2b308543
commit 075528a4a5

View File

@ -60,14 +60,15 @@ repositories {
- 在目录src/main/resources下新建application.yml文件用作项目的主要配置文件。
- 集成springdoc openapi
springdoc openapi可快速为spring boot项目生成规范的 API 文档。
> springdoc openapi可快速为spring boot项目生成规范的 API 文档。
在build.gradle的dependencies中添加依赖
```groovy
implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.5.0'
```
在application.yml中添加配置
在application.yml中添加配置,设置swagger-ui的访问路径
```yaml
springdoc:
swagger-ui:
@ -76,7 +77,7 @@ springdoc:
- 配置项目日志
spring boot中配置日志可以在application.yml/application.properties中配置。也可以使用单独的配置文件logback.xml来配置。
> spring boot中配置日志可以在application.yml/application.properties中配置。也可以使用单独的配置文件logback.xml来配置。
在src/main/resources下新建一个名为`logback.xml`的文件,内容如下:
```xml
@ -121,10 +122,41 @@ spring boot中配置日志可以在application.yml/application.properties中配
</configuration>
```
6、配置h2数据库和JPA
- 在application.yml中添加配置
```yaml
spring:
datasource:
url: jdbc:h2:file:./paopao.h2
driverClassName: org.h2.Driver
username: root
password: root
# initialization-mode: always
h2:
console: # 开启console 访问 默认false
enabled: true
settings:
trace: true # 开启h2 console 跟踪 方便调试 默认 false
web-allow-others: true # 允许console 远程访问 默认false
path: /h2 # h2 访问路径上下文
jpa:
show-sql: true
open-in-view: false
defer-datasource-initialization: true
database-platform: org.hibernate.dialect.H2Dialect
hibernate:
ddl-auto: update # update create-drop
properties:
hibernate:
format_sql: true
dialect: org.hibernate.dialect.H2Dialect
```
6、运行项目
7、运行项目
- 使用gradle的任务 `bootRun`运行项目,在控制台可以看到spring boot项目启动成功的信息并生成了openapi文档。