乐于分享
好东西不私藏

30 个接口文档,我用 TRAE Skill 半天搞完了

30 个接口文档,我用 TRAE Skill 半天搞完了

上个月,我接了一个活儿:给公司内部系统写接口文档。

项目有 30 多个 Controller,大部分接口都没有注释,历史代码乱得很。估摸着手工整理要两三天。

我没有慌。

打开 TRAE,建了一个 Skill,半天搞完,交付了一份格式统一的接口文档。

同事问我怎么做到的,我把 Skill 这个功能讲给他听,他说:”怎么没人告诉我有这玩意儿。”

今天我来告诉你。


Skill 是什么?

简单说,Skill 是你给 AI 定制的”工作手册”。

普通对话里,每次问 AI 都要重新说背景、重新讲规范、重新给格式要求——很烦,而且 AI 很容易忘。

有了 Skill,你把这些一次性写清楚:这个项目用什么框架、代码风格是什么、输出格式要长什么样。以后每次用这个 Skill,AI 就自动带着这些上下文开工,不用你反复交代。

本质上,它是”有记忆、有规范的 AI 助手”。


实战:用 Skill 批量生成接口文档

下面是我当时的完整操作流程,可以直接复用。

第一步:创建 Skill

打开 TRAE,左侧面板找到 Skill 入口,点击「新建」。

给 Skill 起个名字:接口文档生成器

第二步:写 Skill 说明(最关键的一步)

在 Skill 描述框里,我写了这段话:

你是一个专门负责生成 Java 接口文档的助手。项目使用 Spring Boot 3 + MyBatis Plus,接口风格为 RESTful。

每次我给你一段 Controller 代码,你需要输出以下格式的文档:

– 接口名称
– 请求方式和路径
– 请求参数(字段名、类型、是否必填、说明)
– 返回值说明
– 示例(JSON 格式)

输出用 Markdown 格式,每个接口之间用 — 分隔。如果代码中有明显的参数校验逻辑,补充到参数说明里。

这段话就是 AI 的”工作手册”,写得越清楚,出来的东西越稳定。

第三步:关联项目文件(可选但强烈推荐)

Skill 支持绑定项目目录。我把整个 controller 目录关联进去,AI 就能直接读取文件,不需要我每次手动复制代码。

设置路径后,在对话框里直接说”帮我给 UserController 生成文档”,它就知道去哪里找。

第四步:开始批量生成

激活这个 Skill,然后逐个告诉它处理哪个 Controller:

帮我给 UserController 生成接口文档

帮我给 OrderController 生成接口文档

帮我给 ProductController 生成接口文档

每次输出格式完全一致,不用反复调整。

30 个 Controller,我花了大概 2 小时,比估计的快了一整天。


Skill 还能用在哪里?

接口文档只是一个场景,只要是”需要统一格式、反复执行”的任务,都可以建 Skill:

Skill 名称 用途
单元测试生成器 指定测试框架(JUnit5 + Mockito),固定命名规范,批量为 Service 层补测试
代码 Review 助手 规定检查清单:事务、NPE、SQL注入、日志规范,每次提交前过一遍
SQL 优化顾问 告诉 AI 你的数据量级和索引现状,每次贴慢查询让它分析
异常处理规范化 统一项目的异常类结构和错误码,让 AI 按规范改写异常处理
需求转任务拆解 输入产品需求描述,输出开发任务清单,自动估时

写好 Skill 说明的 3 个要点

Skill 好不好用,关键在于说明写得怎样。我总结了 3 条:

① 说清楚你的技术栈

框架版本、ORM 工具、数据库类型——越具体越好。”Spring Boot 3 + MyBatis Plus + MySQL 8″比”Java 项目”有用 10 倍。

② 给出输出格式样板

不要说”帮我输出文档”,要说”按以下格式输出:字段名 / 类型 / 是否必填 / 说明”。有样板,格式才不会飘。

③ 说明边界和例外处理

比如:”如果方法上没有注解,跳过不处理””如果参数超过 10 个,只列必填项”——这类边界说清楚,AI 就不会在细节上乱发挥。

Skill 说明其实就是一份给 AI 看的需求文档,写得好,省心省力。


Skill 是 TRAE 里最被低估的功能之一。

很多人用 AI 编程,每次都从零开始说背景,反复踩重复的坑。有了 Skill,你是在积累资产,每建一个好的 Skill,下次同类任务就快一倍。

这才是 AI 工具该有的用法——不是每次都从头开始,而是越用越顺手。


你在项目里有哪些反复做的重复性任务?
欢迎在评论区说说,说不定我帮你出一个 Skill 模板。

觉得有用,转发给你团队里用 TRAE 的同事——这个功能很多人还不知道。

——VibeCoding大爆炸,持续分享 AI 编程的真实经验