Agent Skills
返回列表
代码自动生成 OpenAPI 接口文档

代码自动生成 OpenAPI 接口文档

开发编程 更新于 2026.08.29

将以下提示词粘贴到你的 AI 对话框中:

请根据 https://skillhub.cn/install/skillhub.md,安装 @user_94e0d4e4/openapi-auto-generator。

技能介绍

要解决什么问题

接口实现写在 Controller/Service 里之后,文档往往滞后:手写 OpenAPI/Swagger 容易漏字段、路径与真实代码不一致,再同步到 Apifox、Postman 又要重复维护。这个技能面向「新端点已经能编译通过」的时刻,把文档生成从事后补作业变成实现流程里的一步。

技能如何工作

触发场景是:新建或改完 API 端点(Controller/Service 层),且工程已成功编译之后。技能会按 OpenAPI 3.1 规范产出描述,并采用 每个 API 端点对应一个文件 的粒度,便于按路由拆分、评审和版本管理。

生成物是标准 OpenAPI,而不是某个工具的私有格式,因此可以导入 Apifox、Postman 等支持 OpenAPI 的生态,用同一份契约做调试、Mock 或协作。

适用边界与注意点

  • 它解决的是文档契约的生成与对齐,不替代你在代码里对鉴权、错误码、分页等业务约定的设计。
  • 应在实现稳定且编译通过后再生成,避免半成品接口反复改 spec。
  • 若项目已有全局 openapi.yaml 合并策略,需要自行约定如何把「每端点一文件」并入仓库的文档布局。

使用场景

  • 刚在 Controller 里新增 REST 路由且本地编译通过后,需要立刻补一份可与代码对齐的 OpenAPI 3.1 描述
  • 团队用 Apifox 做联调,希望从 Service 层实现反推契约文件,避免手填路径与请求体字段
  • 一次 PR 只改单个端点,想按「每接口一文件」产出 spec,方便 Code Review 对照 diff
  • Postman Collection 要从项目同步更新,需要在合并前把新端点的 OpenAPI 片段单独生成出来

适合人员

  • 维护 Spring/类似分层后端的工程师,每次发版都要把新接口同步给前端与测试用的 Apifox 项目
  • 负责 API 网关或 BFF 的同学,需要让 OpenAPI 文件与 Controller 注解或路由表保持一致
  • 在单体或微服务里写 Service 契约的技术负责人,希望评审时能看到「一端点一文件」的文档增量
  • 用 Postman 管理环境变量的 QA,需要从后端代码生成可导入的 OpenAPI 而不是复制粘贴示例请求