工程开发
http-generate avatar

http-generate

自动为 Spring Boot REST 控制器生成 .http 请求文件,简化 API 文档编写与测试流程。

简介

HTTP Generator 是一个专门为 Spring Boot 开发者设计的自动化工具,旨在简化 API 文档与测试套件的创建流程。通过扫描项目目录中带有 @RestController 或 @Controller 的 Java 文件,它能智能地提取端点映射、HTTP 方法(GET, POST, PUT, DELETE)以及参数配置(包含 @RequestParam 与 @PathVariable)。该工具生成的标准化 .http 文件可直接与 IDE 集成的 REST 客户端兼容,确保 API 示例能与代码库同步更新。

  • 自动检测并映射复杂的多模块 Spring Boot 项目中的 REST 端点。

  • 支持高级映射模式,包含请求参数默认值、路径变量以及针对国际化内容的 URL 编码。

  • 生成的 .http 文件格式规范,包含详细注释、完整 URL 路径,并使用 ### 分隔符进行逻辑分组,便于查看。

  • 通过提供现成的新模块或重构接口的请求示例,有效促进团队协作。

  • 消除手动编写文档的繁琐工作,降低 API 实现与测试规范之间的落差。

  • 使用 python .claude/skills/http-generate/scripts/http_generator.py [module_path] 指令来锁定特定模块,或使用 'all' 参数进行全项目覆盖。

  • 工具依赖于标准 Spring Boot 命名规范,请确保控制器文件以 'Controller.java' 结尾。

  • 支持自定义输出文件名,以利整合进现有的文档工作流中。

  • 专为使用 Spring AI Alibaba 框架与标准 Spring Web 依赖的环境所设计。

  • 请确保执行环境允许执行 Python 脚本,以便进行文件系统交互与源代码分析。

仓库统计

Star 数
2,614
Fork 数
1,100
Open Issue 数
1
主要语言
Java
默认分支
main
同步状态
空闲
最近同步时间
2026年5月3日 16:01
在 GitHub 查看