Java API 文档生成器
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_6d48611e/java-api-doc-generator。
技能介绍
解决的问题
Java Spring Boot 项目里的接口定义散落在多个 @RestController / @Controller 中,前端联调和测试回归时常常需要反复确认 HTTP 方法、路径前缀、查询参数、请求体字段 和 响应结构。手工整理文档容易遗漏参数、过期示例,也让接口变更难以追踪。
工作方式
该技能会先定位 src/main/java 或用户指定的 Controller 包路径,再递归扫描 .java 文件,筛选出接口类。解析时会提取类级 @RequestMapping、方法级 @GetMapping / @PostMapping / @PutMapping / @DeleteMapping / @PatchMapping,并识别 @PathVariable、@RequestParam、@RequestBody、JavaDoc 注释以及 Swagger 注解中的描述与示例。随后通过 Python 脚本生成 API_DOCUMENTATION.md,按 Controller 分章输出接口说明、参数表、请求体示例、响应示例和废弃标记。
适用边界
解析基于正则表达式,能覆盖常见 Spring Boot 写法,但对复杂泛型、继承接口、动态路由的精度有限。文档默认不生成认证授权细节,响应示例也多为占位数据;建议在代码中补充 @ApiOperation、@ApiParam、@ApiResponse,再人工校准真实示例。
使用场景
- 前端联调前把 Spring Boot 项目接口整理成 Markdown,供测试核对路径和参数。
- 代码评审时快速查看某包下 Controller 的查询参数、请求体与响应示例。
- 交接 Java 后端服务时,把分散在多个 Controller 的接口生成统一文档。
- 更新接口后重新扫描,标记废弃接口并列出缺失描述或示例。
适合人员
- 维护 Spring Boot 后端的工程师,需要把接口定义整理给前端。
- 测试工程师,需要在联调前核对路径、参数和响应示例。
- 接手 Java 服务的工程师,需要快速梳理分散的 Controller。
- 后端负责人,需要在评审中检查接口描述与废弃标记。