数据库界的Swagger工具，能实现一键自动生成文档吗？

本文共计1444个文字，预计阅读时间需要6分钟。

关于API文档的编写，我们可以使用Swagger等工具来自动生成。但对于数据库表结构文档，实际开发中我们通常会在开发前先设计好表结构，然后进行讨论和优化。这时候，生成文档就显得尤为重要。

对于开发的API文档，我们可以通过Swagger等工具来自动生成了。但是对于数据库表结构的文档呢，在实际开发中在开发前我们一般会先设计好表结构，大家讨论一下，

这个时候就很需要有个数据库表结构的文档，如果常规操作就是一通无脑的 CV 大法，产出一份小几十页的 Word 文档,这样不仅容易出错，而且如果表结构变了还需修改

Word文档，非常不方便。

这里介绍并演示一个开源的 生成数据库表结构的文档 的工具，可以帮我们高效的自动 生成数据库表结构文档。

工具名称: screw。

开源地址: gitee.com/leshalv/screw。

有兴趣的朋友可以研究下源码，没兴趣就直接拿来用就好了。

一、 screw 简介

screw 是一个简洁好用的数据库表结构文档的生成工具 ，支持 MySQL、Oracle、PostgreSQL 等主流的关系数据库。

生成的文档有 HTML、Word、Markdown 三种格式 ，示例如下图所示：

1、Html演示效果 2、Word演示效果 3、Markdown演示效果

看完演示效果，我们接下来看看如果生成 数据库文档，其实非常简单，我们下面示范下。