数据库文档生成工具——screw

在企业级开发中、我们经常会有编写数据库表结构文档的时间付出,如果数据库表结构更新了还得手动更新维护到文档中,很是繁琐。 无意之间发现了github上面有个人写了一个小工具专门来做这个事情,名字叫screw(螺丝刀),用了下很不错。这里特意记录一下。

工具的github地址:https://github.com/pingfangushi/screw

特点

  • 简洁、轻量、设计良好
  • 多数据库支持,目前已支持MySQL、MariaDB、TIDB、Oracle、SqlServer、PostgreSQL、Cache DB
  • 多种格式文档,目前已至此HTML、Word、MarkDown格式
  • 灵活扩展
  • 支持自定义模板

使用

有两种使用方式,一种是通过maven插件引入后执行命令生成,一种是直接写代码来生成文档。 下面我通过MySQL数据库的使用例子来说明。

引入依赖

代码方式

maven插件方式

配置完以后在 maven project -> screw -> screw:run 双击执行ok。

效果图

数据库文档生成工具——screw

0

发表评论

邮箱地址不会被公开。