SuperAPI AI 工具集

api-doc-generator

编程与开发

查看项目

更新于 10-16 03:15

技能介绍

用途:扫描代码中的 API 接口并生成标准化接口文档,仅在明确涉及 API/接口时触发,不用于普通文档请求。

主要能力:识别 @RestController、@Controller 及 @RequestMapping 类;提取 @GetMapping、@PostMapping、@PutMapping、@DeleteMapping、@PatchMapping 等方法的 URL、请求方式、路径参数、查询参数、请求体、请求头与响应结构;支持 R<T>、Page<T> 等包装类型;生成接口一览表、字段表、JSON 响应示例与错误码说明。

使用方式:先扫描项目或指定 Controller,确认接口数量;无接口时停止并提示检查 Controller 与注解。随后逐接口提取信息,选择中文或英文模板(templates/接口文档模板.md 或 templates/api-documentation-template-en.md),按模块组织并生成 Markdown,默认保存到 ./docs/api-documentation.md,多模块时为 ./docs/{module-name}-api-documentation.md,使用 UTF-8 编码。

适用场景:Java/Kotlin Spring Boot 项目的接口文档整理。

限制:资料未提供安装命令、收费、价格与平台信息;未找到接口时无法生成文档。