# spring-doc-generator

**Repository Path**: HaiBoTang112/spring-doc-generator

## Basic Information

- **Project Name**: spring-doc-generator
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-05-25
- **Last Updated**: 2026-05-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Spring Doc Generator - IntelliJ IDEA Plugin

AI 驱动的 Spring Boot 项目功能文档生成插件。

## 功能

- 右键点击 Spring Boot 项目的包/类 → 自动分析代码结构 → AI 生成功能文档
- 支持 Claude / OpenAI / DeepSeek / 通义千问 多种 AI 提供商
- IDE 内嵌预览窗口（Markdown 渲染）
- 导出 Markdown 文件
- 自动识别 Controller、Service、Entity、DTO、Repository、Config

## 开发环境要求

- **JDK 17+** (必须)
- **Maven 3.8+** (必须)
- IntelliJ IDEA 2023.3+ (Community 或 Ultimate，用于测试)

## 快速开始

### 1. 安装 JDK 17

如果只有 JDK 8，需要先安装 JDK 17：
- 下载: https://adoptium.net/download/ (推荐 Eclipse Temurin JDK 17)
- 或使用 IntelliJ IDEA 自带的 JDK

### 2. 编译项目

```bash
# 编译
mvnw.cmd clean compile

# 运行测试
mvnw.cmd test

# 打包插件
mvnw.cmd clean package -DskipTests
# 输出: target/spring-doc-generator-1.0.0.zip
```

### 3. 测试插件

**方式 1: 在 IntelliJ IDEA 中安装测试**

1. `mvnw.cmd clean package` 打包
2. 打开 IntelliJ IDEA → Settings → Plugins → Install Plugin from Disk
3. 选择 `target/spring-doc-generator-1.0.0.zip`
4. 重启 IDEA

**方式 2: 使用 runIde.bat（需安装 IntelliJ IDEA 2023.3+）**

```bash
runIde.bat
```

这会编译插件并在沙盒 IDEA 实例中运行。

### 4. 配置 AI API

在 IDEA 中:
1. Settings → Tools → Spring Doc Generator
2. 选择 AI Provider (推荐 DeepSeek，国内网络稳定)
3. 填入 API Key
4. 点击 Test Connection 验证

## 使用方式

1. 在 Project View 中右键点击 Java 包或类
2. 选择 "Generate Feature Documentation"
3. 等待代码分析和 AI 生成完成
4. 在右侧工具窗口查看生成的文档
5. 可导出为 Markdown 文件

## AI Provider 配置

| Provider | API 地址 | 获取 API Key |
|----------|---------|-------------|
| DeepSeek | https://api.deepseek.com/v1 | https://platform.deepseek.com |
| OpenAI | https://api.openai.com/v1 | https://platform.openai.com |
| Claude | https://api.anthropic.com | https://console.anthropic.com |
| 通义千问 | https://dashscope.aliyuncs.com | https://dashscope.console.aliyun.com |

## 项目结构

```
src/main/java/com/github/springdocgen/
├── actions/       # IDEA 右键菜单动作
├── ai/            # AI API 抽象层 + 4 个 Provider 实现
├── core/          # 核心分析引擎 + 数据模型
│   └── model/     # 数据类（POJO）
├── psi/           # PSI 解析器（Spring 注解提取）
├── settings/      # 持久化配置（API Key 等）
├── tasks/         # 后台任务编排
└── ui/            # 工具窗口 + Markdown 预览
```

## 常用 Maven 命令

| 命令 | 说明 |
|------|------|
| `mvnw.cmd clean compile` | 编译 |
| `mvnw.cmd test` | 运行测试 |
| `mvnw.cmd clean package -DskipTests` | 打包插件 zip |
| `mvnw.cmd versions:display-dependency-updates` | 检查依赖更新 |

## 商业化路径

- **免费版**：基础功能，自带 API Key
- **付费版**：团队共享配置、批量导出 PDF、自定义 Prompt 模板
- **企业版**：私有部署、CI/CD 集成