Java 项目文档生成器

版本: 1.0 | 适配: Spring Boot 2.x / 3.x

概述

本 Skill 用于分析 Java Spring Boot 项目，自动生成以下文档：

接口设计说明书格式

采用客户要求的传统格式：

1. 接口规范
   1.1 调用说明（调用参数结构、JAVA 代码示例）
   1.2 共用的参数（状态码、共用对象数据结构）
   1.3 返回数据说明
2. 接口方法列表
   2.1 本系统提供的接口
   2.2 本系统需要访问的第三方接口（可选）
3. 数据字典（自动从枚举类生成）
附录：Swagger/Knife4j 在线文档访问说明

特性

触发词

当用户使用以下命令时激活此技能：

工作流程

第一步：项目分析

分析以下文件获取项目信息：

第二步：生成文档

根据分析结果，在项目根目录创建 docs/ 文件夹，并生成对应文档。

第三步：生成脚本（部署手册）

如果项目不存在启停脚本，自动生成以下脚本到 scripts/ 目录：

详细规范

点击查看各模块的详细实现规范：

文档模板

使用以下模板生成标准文档：

使用示例

示例 1：生成所有文档

用户: /java-docs

执行步骤：

1. •分析项目结构和配置
2. •生成 docs/api-doc.md
3. •生成 docs/deployment.md
4. •生成 docs/operations.md
5. •如果不存在启停脚本，生成 scripts/ 目录下的脚本

示例 2：仅生成接口文档

用户: /api-doc

执行步骤：

1. •分析配置文件获取端口
2. •检测 Swagger/Knife4j 配置
3. •扫描 Controller 获取接口清单
4. •生成 docs/api-doc.md

示例 3：生成部署手册

用户: /deploy-doc

执行步骤：

1. •分析依赖获取环境要求
2. •检测 Dockerfile 判断部署方式
3. •分析配置文件获取配置项
4. •生成 docs/deployment.md
5. •生成启停脚本（如果不存在）

注意事项

1. •接口文档格式：采用客户要求的传统格式，包含接口规范、方法列表、数据字典三部分
2. •枚举类分析：自动扫描 enums 包下的枚举类生成数据字典，支持 code + desc 模式
3. •共用对象识别：自动识别统一返回对象（Result/CommonResult）、分页对象等
4. •Knife4j 导出：提供在线文档访问地址，详细接口文档可通过 Knife4j 导出后合并
5. •部署方式自动检测：根据是否存在 Dockerfile 自动判断部署方式
6. •脚本生成：仅在 scripts/ 目录不存在同名脚本时才生成
7. •配置安全：生成文档时自动脱敏敏感配置（密码、密钥等）

版本历史