> 文档中心 > 数据库文档工具ShowDB,Java开发者的数据库文档利器

数据库文档工具ShowDB,Java开发者的数据库文档利器


Git地址

戳这儿

简介

⚡拆箱即用的数据库文档工具,自动将SpringBoot项目中的所有数据源文档可视化,同时监控数据库相关的信息,如主从状态,配置等

为啥开发这个

  • 在使用screw的时候,需要配置数据源的连接信息,然后才会生成一个基于当前数据源的表结构文档🤪

  • 但是这个文档它是不可变的,且每次数据库修改了表结构,这个文档就得重新生成,何况,如果是多数据源,难道就需要生成多个文档嘛💐,那么这就太麻烦了,在实际开发过程中,迭代快的情况下往往就需要经常重新生成文档,这对于懒人来说是件很麻烦的事情

  • 那么咱就大漏特漏😵,现如今微服务基本都会连接上数据源🍎,所以如果能够对SpringBoot项目中已经存在的数据源/多数据源,自动生成文档,那么会更迎合Java-er/Spring-er的使用习惯,就像swagger一样,拆箱即用,且支持用户的一些个性化的自定义配置🎠,同时也可以对数据源进行一些信息的监控,如比较关心的主从状态,客户端连接,一些数据库的配置信息等等,这些也都能集成进来,使其更符合ShowDB的名字 🐥

✋Features

  • 拆箱即用,引入pom文件,即可使用
  • UI界面丰富
  • 文档可视化,能对数据库表结构一览无余,支持模糊搜索
  • 支持多数据源,自动对环境中存在的数据源进行监控与文档化
  • 5 支持数据库表结构SQL迁移,数据库表结构文档下载
  • 6 支持数据库主从信息实时监控,数据库配置信息查询,数据库连接信息展示
  • 7 支持表详细信息查询(如数据量大小,索引大小,存储引擎等),表的建表SQL,Java实体类代码生成

🧰如何使用??

  • 在SpringBoot项目的pom.xml文件中引入依赖

pom.xml

    cn.cocowwy    showdb-spring-boot-starter    1.0.0

yml

showdb:  enable: true  endpoint: '*' 
  • 项目中已经配置好单数据源(多数据源看下面的例子)
  • 浏览器中访问该路径:/db,即可自动生成当前项目里的所有数据源文档页面

接下来就能看到如下页面:

更多详情请看git主页:GitHub - Cocowwy/ShowDB: 📖数据库文档工具,拆箱即用,支持多数据源表结构可视化,数据库敏感信息监控等