数据库设计文档自动生成

本文介绍了如何使用JDK17和Maven环境通过Git下载代码,使用IDEA或命令行方式运行项目。项目提供SwaggerUI接口用于管理数据库信息并生成Word或Excel文档。遇到问题如缺少JDK17,可调整POM文件适应JDK1.8。若表不存在,需执行H2数据库的sql脚本。
摘要由CSDN通过智能技术生成

1、拉取代码

该项目上使用了jdk17版本,需要maven环境。如果都有,通过git进行下载代码

#git下载代码命令
git clone https://gitee.com/giteeLinht/db-doc.git

2、初始化项目并运行

1、打开idea,导入项目直接运行com.cn.db.dbdoc.DbDocApplication

2、没有idea,可以直接在db-doc文件夹下,通过mvn clean install进行打包成可运行的jar文件。然后把db-doc/data目录拷贝到target里。然后在target里通过java -jar db-doc-0.0.1-SNAPSHOT.jar

3、验证:在浏览器里输入:http://localhost:8080/swagger-ui/index.html

3、生成数据库设计文档

1、浏览器输入:http://localhost:8080/swagger-ui/index.html

2、通过/db/add接口添加数据库信息返回id

3、根据返回的id,调用/export/word或/export/excel传入id导出数据库文档。如下图所示:

 

 

 

 

 

 

4、疑难杂症

1、要使用jdk17,如果没有jdk17,使用jdk1.8,请在pom文件中降低jdk版本和springboot的版本,同时降低spring-doc的版本

2、通过接口新增数据库信息报错表不存在时,可以在浏览器中登录H2数据库,并在浏览器中执行/data目录下的schema-h2.sql脚本,登录的账号信息请查看application.properties

 

 

 

 

  • 2
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值