使用screw一键生成数据库文档

screw是一款简洁好用的数据库表结构文档生成器（maven插件）。
github：https://github.com/pingfangushi/screw
下面使用Spring Boot对screw进行集成。

一. screw的配置

配置pom文件

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"><modelVersion>4.0.0</modelVersion><parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-parent</artifactId><version>2.2.9.RELEASE</version><relativePath /> <!-- lookup parent from repository --></parent><groupId>com.bee</groupId><artifactId>screw-demo</artifactId><version>0.0.1-SNAPSHOT</version><name>screw-demo</name><description>Screw Demo for Spring Boot</description><properties><java.version>1.8</java.version></properties><dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-test</artifactId><scope>test</scope><exclusions><exclusion><groupId>org.junit.vintage</groupId><artifactId>junit-vintage-engine</artifactId></exclusion></exclusions></dependency><dependency><groupId>cn.smallbun.screw</groupId><artifactId>screw-core</artifactId><version>1.0.4</version></dependency></dependencies><build><plugins><plugin><groupId>org.springframework.boot</groupId><artifactId>spring-boot-maven-plugin</artifactId></plugin><plugin><groupId>cn.smallbun.screw</groupId><artifactId>screw-maven-plugin</artifactId><version>1.0.4</version><dependencies><!-- HikariCP --><dependency><groupId>com.zaxxer</groupId><artifactId>HikariCP</artifactId><version>3.4.5</version></dependency><!--mysql driver --><dependency><groupId>mysql</groupId><artifactId>mysql-connector-java</artifactId><version>8.0.20</version></dependency></dependencies><configuration><!--username --><username>root</username><!--password --><password>123456</password><!--driver --><driverClassName>com.mysql.cj.jdbc.Driver</driverClassName><!--jdbc url --><jdbcUrl>jdbc:mysql://localhost:3306/db_mybatis</jdbcUrl><!--生成文件类型 --><fileType>HTML</fileType><!--打开文件输出目录 --><openOutputDir>false</openOutputDir><!--生成模板 --><produceType>freemarker</produceType><!--描述 --><description>数据库文档生成</description><!--版本 --><version>1.0.0</version><!--标题 --><title>数据库文档</title></configuration><executions><execution><phase>compile</phase><goals><goal>run</goal></goals></execution></executions></plugin></plugins></build>
</project>

配置数据源
src/main/resources/application.properties

spring.datasource.url=jdbc:mysql://localhost:3306/db_mybatis?useUnicode=true&characterEncoding=UTF-8&useSSL=false
spring.datasource.usename=root
spring.datasource.password=123456
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.xa.properties.useInformationSchema=true

二. 通过Maven插件运行screw

IDEA中运行
Eclipse中运行

处理POM配置文件中的错误（也可以不管这个错误，直接运行）
运行

在Goals中输入：screw:run

三. 生成数据库各表的设计文档

使用screw一键生成数据库文档相关推荐

IDEA常用高效开发工具——screw一键生成数据库文档
screw [介绍:一键生成数据库文档,从此告别人工整理文档] a:数据库支持: MySQL MariaDB TIDB Oracle SqlServer PostgreSQL Cache DB b:配 ...
数据库界的Swagger：一键生成数据库文档！你不了解一下？
对于API的文档,我们有Swagger等工具来自动生成了.但有有一类文档还是常常困扰着我们,那就是数据库表结构的文档.相信很多同学都有过手写数据库表结构文档的经历吧?常规操作就是一通无脑的 CV 大 ...
实用！一键生成数据库文档，堪称数据库界的Swagger
最近部门订单业务调整,收拢其他业务线的下单入口,做个统一大订单平台.需要梳理各业务线的数据表,但每个业务线库都有近百张和订单相关的表,挨个表一个一个字段的弄脑瓜子嗡嗡的. 为了不重复 CV 操作,抱着 ...
swagger连接mysql数据库_一键生成数据库文档，堪称数据库界的Swagger，有点厉害！...
最近部门订单业务调整,收拢其他业务线的下单入口,做个统一大订单平台.需要梳理各业务线的数据表,但每个业务线库都有近百张和订单相关的表,挨个表一个一个字段的弄脑瓜子嗡嗡的. 为了不重复 CV 操作,抱着 ...
超给力，抛弃手动维护，一键生成数据库文档、支持多种格式！
点击关注公众号,实用技术文章及时了解简介在企业级开发中.我们经常会有编写数据库表结构文档的时间付出,从业以来,待过几家企业,关于数据库表结构文档状态:要么没有.要么有.但都是手写.后期运维开发,需 ...
好用！一键生成数据库文档，这个开源的文档生成工具值得了解
Gitee项目地址,可以直接去开源项目查看(推荐) https://gitee.com/leshalv/screw 简介在企业级开发中.我们经常会有编写数据库表结构文档的时间付出,从业以来,待过几家 ...
实用，一键生成数据库文档
screw 项目: 一.数据库支持 MySQL MariaDB TIDB Oracle SqlServer PostgreSQL Cache DB 二.配置 pom文件引入screw核心包,Hika ...
利用java代码一键生成数据库文档
1 screw(螺丝钉)介绍 1.2 特点简洁.轻量.设计良好多数据库支持多种格式文档灵活扩展支持自定义模板 1.2 文档生成支持 html word markdown 1.3 文档截图 1 ...
一键自动生成数据库文档，炫！（告别CV大法）
数据库表结构文档生成器前言一.引入pom.xml依赖二.创建Java类三.使用 Maven 插件的方式总结前言在日常开发中,当项目上线之后,甲方必定会让你提供一堆的验收文档,其中就包括了 ...
java快速生成数据库文档
前言在产品发布前夕,经常因为编写各类设计文档感到心碎,倒不是难,而是比较繁琐,举例来说,像编写数据库文档这种操作来说,对于新手,甚至很多有一定开发经验的同学来说,都觉得是一件费力得事情,下面推荐一个 ...

使用screw一键生成数据库文档

一. screw的配置

二. 通过Maven插件运行screw

三. 生成数据库各表的设计文档

使用screw一键生成数据库文档相关推荐

最新文章

热门文章