登录注册

[开源]一个现代化的数据库文档自动生成工具，支持多种数据源

开源系统分类系统
2026-06-28 09:11 5 次浏览 • 0 次下载 0KB
[开源]一个现代化的数据库文档自动生成工具，支持多种数据源

一、开源项目简介

 数据库文档生成器

一个现代化的数据库文档自动生成工具，支持多种数据源，一键生成专业的数据库文档。

二、开源协议

使用MIT开源协议

三、界面展示

 功能演示

1. 数据库连接模式

图片
  • 支持在线连接数据库
  • 实时解析表结构
  • 安全加密连接信息

2. SQL文件导入

图片
  • 直接上传SQL文件
  • 智能解析CREATE TABLE语句
  • 支持复杂SQL语法

3. 多格式导出

3.1 导出 HTML 文档

图片

3.2 导出 Markdown 文档

图片
图片

四、功能概述

✨ 项目特色

 核心功能

  • 多数据源支持
     - MySQL、PostgreSQL及SQL文件导入
  • 多格式导出
     - HTML、Markdown、Word专业文档
  • 精美主题
     - 现代化UI设计，专业文档样式
  • 智能解析
     - 自动分析表结构、关系、索引

 技术亮点

  • Spring Boot 3
     - 现代化Java后端架构
  • Vue 3 + TypeScript
     - 响应式前端界面
  • MyBatis Plus
     - 高效数据持久层
  • Apache POI
     - 专业Word文档生成
  • JWT认证
     - 安全的用户认证体系

 应用场景

 企业开发

  • 新员工培训
     - 快速了解数据库结构
  • 技术文档
     - 规范的API文档
  • 项目交付
     - 完整的数据库设计文档

 团队协作

  • 前后端协作
     - 统一的数据字典
  • Code Review
     - 数据库变更记录
  • 知识传承
     - 完整的项目文档

 项目管理

  • 数据库设计
     - 可视化表关系
  • 版本管理
     - 数据库变更追踪
  • 质量检查
     - 规范的数据库设计

五、技术选型

 技术栈

后端技术

<技术栈>
    ├── Spring Boot 3.5.6      - 核心框架
    ├── MyBatis Plus 3.5.7     - ORM增强
    ├── MySQL 8.0              - 数据存储
    ├── JWT                    - 安全认证
    ├── Apache POI             - Office文档
    ├── FreeMarker             - 模板引擎
    └── JSqlParser             - SQL解析
</技术栈>

前端技术

{
"框架": "Vue 3 + TypeScript",
"UI库": "Element Plus",
"状态管理": "Pinia",
"路由": "Vue Router 4",
"构建工具": "Vite",
"HTTP客户端": "Axios"
}

项目结构

database-document-springboot/
├── sql/                  # SQL文件
├── src/main/java/com/document/
│   ├── config/           # 配置类
│   ├── controller/       # 控制器层
│   ├── service/          # 业务逻辑层
│   ├── mapper/           # 数据访问层
│   ├── entity/           # 实体类
│   ├── dto/              # 数据传输对象
│   └── common/           # 通用组件
│   └── filter/           # 过滤器
│   └── handler           # 异常处理
│   └── vo                # 视图对象
├── src/main/resources/
│   └── application.yml   # 应用配置
└── database-document-vue3/
    ├── src/views/        # 页面组件
    ├── src/components/   # 业务组件
    ├── src/stores/       # 状态管理
    ├── src/api/          # 接口管理
    ├── src/types/        # TypeScript类型
    ├── src/router/       # 路由配置
    └── src/styles/       # 样式文件

快速开始

环境要求

  • JDK 17+
  • MySQL 8.0+
  • Maven 3.6+
  • Node.js 20+

后端启动

# 克隆项目
git clone database-document-springboot
# 导入sql
# 连接数据库，启动即可

前端启动

# 克隆项目
git clone database-document-vue3
# 安装依赖
npm install
# 启动开发服务器
npm run dev

使用指南

1. 数据库连接模式

-- 输入数据库连接信息
主机: localhost
端口: 3306
数据库: your_database
用户名: root
密码: ******

2. SQL文件模式

-- 上传SQL文件
CREATE TABLE users (
    id BIGINT PRIMARY KEY AUTO_INCREMENT,
    username VARCHAR(50) NOT NULL,
    email VARCHAR(100)
) COMMENT '用户表';

3. 生成文档

# 导出格式选择
✅ HTML
✅ Markdown

致谢

感谢以下开源项目：

  • Spring Boot
  • Vue.js
  • Element Plus
  • Apache POI
评论