1. Project Overview

 Database Documentation Generator

A modern automated database documentation generation tool that supports multiple data sources and generates professional database documentation with a single click.

2. Open Source License

Licensed under MIT

3. Screenshots

 Feature Demonstrations

1. Database Connection Mode

• Supports online database connections
• Parses table structures in real time
• Securely encrypts connection information

2. SQL File Import

• Upload SQL files directly
• Intelligently parses CREATE TABLE statements
• Supports complex SQL syntax

3. Multi-Format Export

3.1 Export HTML Documentation

3.2 Export Markdown Documentation

4. Feature Overview

✨ Project Highlights

 Core Function

• Multiple data source support
   - MySQL, PostgreSQL, and SQL file imports
• Multi-Format Export
   - Professional HTML, Markdown, and Word documentation
• Beautiful Themes
   - Modern UI design with professional documentation styles
• Intelligent Parsing
   - Automatically analyzes table structures, relationships, and indexes

 Technical Highlights

• Spring Boot 3
   - Modern Java backend architecture
• Vue 3 + TypeScript
   - Responsive frontend interface
• MyBatis Plus
   - High-performance data persistence layer
• Apache POI
   - Professional Word document generation
• JWT Authentication
   - Secure user authentication system

 application scenarios

 Enterprise Development

• New Employee Training
   - Quickly understand database structures
• Technical Documentation
   - Standardized API documentation
• Project Delivery
   - Complete database design documentation

 Team Collaboration

• Frontend and Backend Collaboration
   - Unified data dictionary
• Code Review
   - Database change records
• Knowledge Transfer
   - Complete project documentation

 Project Management

• Database Design
   - Visualized table relationships
• Version Management
   - Database change tracking
• Quality Inspection
   - Standardized database design

5. Tech Stack

 Technical stack

Back-end Technology

<Tech Stack>
    ├── Spring Boot 3.5.6      - Core framework
    ├── MyBatis Plus 3.5.7     - ORM enhancements
    ├── MySQL 8.0              - Data storage
    ├── JWT                    - Security authentication
    ├── Apache POI             - Office documents
    ├── FreeMarker             - Template engine
    └── JSqlParser             - SQL parsing
</Tech Stack>

Front-end Technology


{
"Framework": "Vue 3 + TypeScript",
"UI Library": "Element Plus",
"State Management": "Pinia",
"Routing": "Vue Router 4",
"Build Tool": "Vite",
"HTTP Client": "Axios"
}

Project Structure

database-document-springboot/
├── sql/                  # SQL Files
├── src/main/java/com/document/
│   ├── config/           # Configuration Class
│   ├── controller/       # Controller Layer
│   ├── service/          # Business Logic Layer
│   ├── mapper/           # Data Access Layer
│   ├── entity/           # Entity Class
│   ├── dto/              # Data Transfer Objects
│   └── common/           # Common Components
│   └── filter/           # Filters
│   └── handler           # Exception Handling
│   └── vo                # View Objects
├── src/main/resources/
│   └── application.yml   # Application Configuration
└── database-document-vue3/
    ├── src/views/        # Page Components
    ├── src/components/   # Business Components
    ├── src/stores/       # State Management
    ├── src/api/          # API Management
    ├── src/types/        # TypeScript Types
    ├── src/router/       # Route Configuration
    └── src/styles/       # Style Files

Quick Start

Environment Requirements

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

Starting the Backend

# Clone the project
git clone database-document-springboot
# Import SQL
# Connect to the database and start immediately

Frontend Startup

# Clone the project
git clone database-document-vue3
# Install dependencies
npm install
# Start the Development Server
npm run dev

User Guide

1. Database Connection Mode

-- Enter database connection information
Hosts: localhost
Port: 3306
Database: your_database
Username: root
Password: ******

2. SQL File Mode

-- Upload SQL File
CREATE TABLE users (
    id BIGINT PRIMARY KEY AUTO_INCREMENT,
    username VARCHAR(50) NOT NULL,
    email VARCHAR(100)
) COMMENT 'User Table';

3. Generate Documentation

# Select Export Format
✅ HTML
✅ Markdown

Acknowledgments

Thanks to the following open-source projects:

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