Trae怎么用AI帮忙生成Swagger接口文档？

Trae框架需集成AI增强Swagger插件实现自动文档生成：安装swagger-ai-annotator、添加AI提示注释、对接本地LLM（如Phi-3-mini）、执行trae swagger:ai命令构建、启用UI悬浮AI解释面板。

☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

如果您使用Trae框架开发API服务，但尚未自动生成Swagger接口文档，则可能是由于未正确集成AI辅助文档生成工具或配置缺失。以下是实现该目标的具体步骤：

一、安装支持AI文档生成的Swagger扩展插件

部分Swagger UI增强插件已集成轻量级AI解析能力，可基于代码注释与路由定义自动补全参数描述、响应示例及错误码说明。需确保选用兼容Trae运行时环境的插件版本。

1、执行命令安装支持AI语义理解的Swagger插件：npm install swagger-ai-annotator --save-dev。

2、在Trae项目根目录下创建swagger-ai-config.json文件，并写入模型调用白名单路径与注释识别规则。

3、修改trae.config.js，在plugins数组中添加swagger-ai-annotator插件实例并传入配置路径。

二、在路由处理函数中添加结构化AI提示注释

Trae支持在@Get、@Post等装饰器下方使用特定格式的多行注释，供AI插件提取语义信息并映射为OpenAPI字段。注释需包含动词意图、业务上下文及数据流向关键词。

1、在控制器方法上方插入以/**@ai开头的块注释。

2、在注释内按行填写：- 输入：用户ID为必填字符串，长度6~12位；- 输出：返回JSON对象含name、level、last_login_time；- 异常：若ID不存在则返回404。

3、保存文件后重启Trae服务，触发插件扫描并缓存注释语义向量。

三、启用本地LLM服务对接Swagger生成流程

当插件检测到注释信息不完整时，会将路由签名与上下文发送至本地运行的轻量LLM（如Phi-3-mini），由其补全缺失的请求体结构、枚举值说明和示例值。该过程依赖HTTP代理转发与token鉴权。

1、下载并启动Phi-3-mini量化模型，监听http://127.0.0.1:8081/v1/chat/completions端点。

Fig

下一代命令行工具，内置AI终端命令自动补全

下载

2、在swagger-ai-config.json中配置"llm_endpoint": "http://127.0.0.1:8081"及对应API密钥。

3、在Trae中间件链中注入swagger-ai-proxy中间件，拦截所有/docs/json请求并注入LLM增强响应头。

四、通过CLI命令触发AI增强版文档构建

Trae CLI提供专用指令，可跳过静态扫描阶段，直接调用AI模块分析源码抽象语法树（AST），识别参数绑定方式、验证装饰器与类型断言，生成高置信度OpenAPI 3.1 Schema。

1、在项目根目录执行：trae swagger:ai --output ./dist/openapi.yaml --include controllers/ --model zephyr-beta。

2、等待CLI输出[AI] Analyzed 12 endpoints, enriched 9 with semantic examples日志。

3、检查生成的openapi.yaml文件中requestBody.content.application/json.schema.example字段是否填充真实业务样例。

五、在Swagger UI中启用AI解释悬浮面板

增强版Swagger UI内置JavaScript钩子，可在鼠标悬停参数字段时发起异步请求，从Trae服务端获取由AI生成的自然语言解释文本，无需离开文档页面即可理解字段含义。

1、确保trae.config.js中swagger.uiOptions.enableAiTooltips设为true。

2、访问http://localhost:3000/docs，打开任意POST接口的“Try it out”面板。

3、将鼠标移至user_role输入框右侧问号图标，查看弹出层中显示的“用户角色：系统预设权限组标识，取值范围为admin/editor/guest，不可为空字符串”。