# document_auto_generation_tool

**Repository Path**: ZhangTurtle/document_auto_generation_tool

## Basic Information

- **Project Name**: document_auto_generation_tool
- **Description**: 文档自动生成工具，包括：1.自动填充 sql 模板；
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 4
- **Created**: 2023-06-25
- **Last Updated**: 2023-06-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## 文档自动生成正具

### 1. 核心思路
1. 不同文档有不同的接口；
2. 入参，根据模板，生成成品。主要是智能生成和填充，模块填充、拼接。

### 2. 文档自动生成
#### 2.1 sql 备份脚自动生成
##### 2.1.1 接口描述
1. 入参：sql 文件，包括所有要上线的 sql 文件；
2. 模板：参考 mybatis 的占位符设计，调研一下；
3. 技术&工具：
   1. sql 解析工具，调研一下；
   2. sql 模板填充；
   3. sql 文件读取和还原；

##### 2.1.2 接口设计
1. 接口定义：POST + application/x-www-form-urlencoded
2. 接口逻辑：
   1. 读取某个文件夹（里面是 sql 文件）；
   2. 遍历所有的 sql 文件，解析 sql 文件，统计涉及到的库名.表名；
   3. 根据模板（内容、文件名都是模板）填充，生成备份脚本。注意备份表里的 sql 表名有后缀：
        - backup_备份脚本.sql
        - backup_回滚脚本.sql
        - backup_删除备份表.sql
        - backup_删除回滚备份表.sql
3. 接口入参：
   1. 存放 sql 的文件夹：sourceFolder(str)
   2. 存放模板的文件夹：templateFolder(str)
   3. 备份表的后缀名：sqlSuffix(str)
   4. 结果输出的文件夹：destinationFolder(str)
4. 接口响应：
   1. 响应体 RespBean


#### 3.1 sql 备份脚自动生成
##### 3.1.1 接口描述
1. 入参：
2. 模板：
3. 技术&工具：

##### 3.1.2 接口设计