使用 screw 快速生成数据库文档

最新推荐文章于 2025-03-24 14:52:23 发布

jeikeryun

最新推荐文章于 2025-03-24 14:52:23 发布

阅读量353

点赞数

分类专栏： mysql 文章标签：数据库 java postgresql

本文链接：https://blog.youkuaiyun.com/weixin_42133138/article/details/129119196

版权

本文介绍如何利用screw工具快速生成数据库文档，支持包括MySQL、Oracle、SqlServer、MariaDB、PostgreSQL在内的多种数据库，可导出为html、word、markdown格式。只需简单配置和运行，即可告别手动整理数据库文档的繁琐工作。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

我们项目最近需要出一个数据库文档，我不想一个一个写，于是在网上找到了这个方法一键生成数据库文档，从此告别人工整理文档。
screw目前支持 MySQL、Oracle、SqlServer、MariaDB、PostgreSQL 等数据库，生成文档目前支持html、word、markdown 文档格式。

引入screw的maven依赖：

  <dependency>
            <groupId>cn.smallbun.screw</groupId>
            <artifactId>screw-core</artifactId>
            <version>1.0.2</version>
        </dependency>

逻辑层代码

/**
 * 文档生成
 */
void documentGeneration() {
   
   //数据源
   HikariConfig hikariConfig = new HikariConfig();
   hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");
   hikariConfig.setJdbcUrl