通义灵码可自动生成API文档，需先启用插件并用阿里云账号登录；在Controller方法上通过快捷键、右键菜单或指令/generate apidocs触发；生成前须补全Javadoc及DTO字段注释并保存文件。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜
在前后端分离开发中，每次写完Controller方法都要手动补全Swagger注解、整理参数说明、维护响应结构，稍有遗漏就导致前端联调卡壳。通义灵码能基于已有Java代码自动提取接口信息，生成标准Markdown格式的API文档，省去重复劳动。
确认插件已启用并完成登录
打开IDEA → File → Settings → Plugins → 搜索“TONGYI Lingma” → 确保状态为Enabled；若未安装，点击Install后重启IDEA；启动后点击右侧通义灵码面板中的头像图标，用阿里云账号或支付宝扫码完成登录。【未登录状态下所有AI功能均不可用】
登录成功后，面板右上角会显示用户昵称和在线状态，此时方可进行后续操作。
在Controller方法上触发文档生成
方法一：鼠标光标定位到目标@PostMapping、@GetMapping等接口方法名上（例如handlePayRequest），按快捷键 Alt + Insert → 在弹出菜单中选择 REST API → 选择输出位置（推荐选当前包下的docs目录）→ 点击OK。
方法二：右键点击方法名 → 选择 Generate → 再选 REST API → 后续步骤同方法一。
通义灵码 Linux版是阿里云推出的一款AI智能编码助手，专为Linux开发者设计。它支持在Linux操作系统下的JetBrains IDEs、Visual Studio Code等主流集成开发环境中运行。该工具基于通义大模型，提供代码智能生成、实时续写、单元测试生成、代码优化以及研发智能问答等功能，旨在帮助Linux用户在编码过程中提升效率。
方法三：直接选中整个方法代码块 → 在通义灵码面板中输入指令 /generate apidocs → 回车执行。该方式会自动识别请求方式、路径、入参实体、返回类型，并递归解析DTO字段注释生成完整表格。
确保文档内容准确的关键准备
第一步：检查方法上的Javadoc是否已补充完整。例如：
/**
* 用户支付回调处理
* @param request 支付平台推送的原始通知数据，含trade_no、amount、status等字段
* @return 成功返回{"code":0,"msg":"success"}，失败返回对应错误码
*/
必须存在，否则生成的“接口说明”和“错误码”部分将为空。
第二步：确认入参和出参DTO类中每个字段都有@ApiModelProperty或Javadoc注释。例如：
private BigDecimal amount; // 订单金额，单位：分，精度保留两位小数
没有字段级注释，生成的入参表格第三列“说明”将全部显示为“无”。
第三步：运行前先保存所有相关文件（Ctrl+S），避免因缓存未刷新导致字段解析失败。
