# screw-gui

**Repository Path**: liveBetter/screw-gui

## Basic Information

- **Project Name**: screw-gui
- **Description**: 数据库生成工具和接口文档生成工具, 支持数据库预览、生成html/md/doc 三种数据库文档，支持生成swagger2.0和openApi3.0 文档。
- **Primary Language**: Java
- **License**: LGPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 2
- **Created**: 2023-02-13
- **Last Updated**: 2025-05-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Swing, screw, Java, Doc, API

## README

### 前言

支持数据库预览、生成 html/md/doc 三种数据库文档，支持生成 swagger2.0 和 openApi3.0 文档。
当前工程数据库只支持 mysql 和 sqlite3, 可根据需求自定义参考:3.0 扩展

### 1. 生成数据库文档

- 核心依赖[screw](https://gitee.com/leshalv/screw.git) ,将 screw 可视化,切换数据源和文档信息生成即可.
- 支持预览库 (主要作用,生成文档时指定某些表/ 忽略某些表)
- 历史备份, 加载历史数据库连接信息

使用示例

![在这里插入图片描述](assets/demo-screw.gif)

### 2. 生成 swagger 文档/openApi3.0 文档

1.  选择 api 类型
2.  填写生成文本
3.  选择 API 方式接口或文本，生成即可

![在这里插入图片描述](assets/demo-swagger.gif)

### 3. 扩展

screw-swing/pom.xml 只依赖了 mysql,如果想添加 postgresql 可以直接引入依赖。

```
<dependency>
    <groupId>org.postgresql</groupId>
    <artifactId>postgresql</artifactId>
    <version>VERSION</version>
</dependency>
```

因为各个数据库版本多，而且各版本跟服务器安装版本相绑定，动态 jar 下载（难点）并加载有点复杂，所以有需求得话 需要手动扩展。

#### 3.1. build/screw-swing-0.0.1.jar 无法运行

> 安装 jdk 1.8+

#### 3.2. build/ScrewDoc.exe 无法运行

> exe4j 寻找 jdk 策略, 可以自己重新构建 exe
> ![在这里插入图片描述](assets/eve4j-env.png)

#### 3.3. 如何打包通用得 exe

> 使用 exe4j 打包 exe 时内嵌 jre