trae ide中api文档未生成是因未启用文档工具链或输出格式未配置；需依次启用trae agent插件、配置openapi输出格式、基于代码注释生成、接入mcp外部源、注入定制化模板。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜
如果您在Trae IDE中已完成接口开发，但尚未生成结构化、可交付的API文档，则可能是由于未启用文档生成工具链或输出格式配置缺失。以下是实现自动化API接口文档生成的具体步骤：
一、启用Trae Agent文档生成工具链
该步骤确保Trae IDE具备解析代码语义并提取接口元数据的能力，是后续所有文档生成操作的基础支撑。
1、打开IntelliJ IDEA → File → Settings → Plugins
2、在Marketplace搜索框中输入Trae Agent
3、点击Install安装插件，安装完成后重启IDE
4、重启后进入Settings → Trae → Tools，确认str_replace_based_edit_tool与json_edit_tool均已启用
二、配置API文档输出格式
输出格式决定生成文档的结构、字段粒度及适配目标平台（如Swagger UI、Apifox、内部Wiki），需按项目交付标准精确设定。
1、进入Settings → Trae → Rules
2、在outputFormat字段中选择对应格式：OpenAPI 3.0 YAML（推荐用于本地调试与CI集成）或OpenAPI 3.0 JSON（适用于Apifox/Yapi等平台导入）
3、若需对接前端组件库（如Ant Design Vue），勾选Frontend Schema Mapping选项
4、在codeStyle字段中指定规范模板：Alibaba Java Coding Guidelines（影响参数命名转换逻辑）
三、从代码注释直接生成文档
该方法依赖源码中的结构化注释，无需额外维护独立文档文件，保障文档与代码始终一致。
1、确保Java/Python等目标语言的接口方法包含Google风格文档字符串，含Args、Returns、Raises等区块
2、右键点击含注释的接口类 → 选择Generate API Documentation
3、在弹出窗口中指定输出路径，例如：docs/api/openapi.yaml
4、点击Generate，Trae将自动提取路径、方法、请求体、响应体、状态码及示例值
四、通过MCP插件接入外部API文档源
当接口定义已存在于Swagger、Apifox或Yapi等平台时，此方式可跳过代码注释环节，直接同步权威定义。
1、获取目标平台的API访问令牌（如Apifox的APIFOX_ACCESS_TOKEN）及项目ID（project-id）
2、进入Settings → Trae → MCP Servers → 点击+号添加新服务器
3、填入JSON配置：{"command":"npx","args":["-y","apifox-mcp-server@latest","--project-id=11122223333"],"env":{"APIFOX_ACCESS_TOKEN":"APS-XXXXXXXXXXXXXXXXXXXX"}}
4、保存后重启MCP服务，在Trae侧执行Sync from MCP Server命令
五、定制化文档片段注入
针对需人工补充说明的业务规则、安全约束或调用限制，可通过模板变量注入非代码衍生内容。
1、在项目根目录创建docs/templates/api-header.md文件
2、在文件中编写Markdown格式的通用说明，使用占位符如{{last_updated}}、{{version}}、{{base_url}}
3、进入Settings → Trae → Documenter → Template Path，指向该文件路径
4、执行文档生成时，Trae将自动合并代码解析结果与模板内容，生成完整交付物
大量免费API接口：立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游，为数据API应用能力赋能！
