通义灵码API文档生成指南：AI自动解析Controller方法

在前后端分离的开发架构中，编写完Controller方法后，经常需要手动补齐Swagger注解、整理接口参数说明、维护响应数据结构，稍不留神就容易遗漏，导致前端联调时出现阻塞。通义灵码能够基于已有的Java代码自动提取接口信息，生成标准Markdown格式的API文档，大幅减少重复劳动。不过，生成前要确保插件已启用、已登录，并且Controller方法上的Javadoc和DTO字段注释都已补全。

确认插件已启用并完成登录

打开IDEA → File → Settings → Plugins → 搜索“TONGYI Lingma”，确认状态为Enabled。如果未安装，点击Install后重启IDEA。启动后点击右侧通义灵码面板中的头像图标，使用阿里云账号或支付宝扫码登录。【未登录状态下所有AI功能均不可用】

登录成功后，面板右上角会显示用户昵称和在线状态，此时才能进行后续操作。

在Controller方法上触发文档生成

方法一：将鼠标光标定位到目标@PostMapping、@GetMapping等接口方法名上（例如handlePayRequest），按快捷键 Alt + Insert → 在弹出菜单中选择 REST API → 选择输出位置（推荐当前包下的docs目录）→ 点击OK。

方法二：右键点击方法名 → 选择 Generate → 再选 REST API → 后续步骤同方法一。

方法三：直接选中整个方法代码块 → 在通义灵码面板中输入指令 /generate apidocs → 回车执行。该方式会自动识别请求方式、路径、入参实体、返回类型，并递归解析DTO字段注释生成完整的表格。

确保文档内容准确的关键准备

第一步：检查方法上的Javadoc是否已补充完整。例如：
/**
* 用户支付回调处理
* @param request 支付平台推送的原始通知数据，含trade_no、amount、status等字段
* @return 成功返回{"code":0,"msg":"success"}，失败返回对应错误码
*/
必须存在，否则生成的“接口说明”和“错误码”部分将为空。

第二步：确认入参和出参DTO类中每个字段都有@ApiModelProperty或Javadoc注释。例如：
private BigDecimal amount; // 订单金额，单位：分，精度保留两位小数
缺少字段级注释时，生成的入参表格第三列“说明”将全部显示为“无”。

第三步：运行前先保存所有相关文件（Ctrl+S），避免因缓存未刷新导致字段解析失败。

来源：互联网