通义灵码可快速生成Swagger注释与技术文档：登录插件后，光标定位方法或类名，通过快捷键或右键菜单触发，自动解析签名、参数与返回值生成合规OpenAPI 3注释；支持单接口、整Controller批量生成及OpenAPI文件反向生成文档。

你正在赶工期，Controller 接口刚写完但 Swagger 注释一个没加，前端同事催着要文档联调——通义灵码能在光标定位后几秒内，基于方法签名、参数类型、返回值和已有 Javadoc，自动生成合规、可直接运行的接口文档，跳过逐行补全的低效环节。

确认插件已安装并完成阿里云账号登录

打开 IntelliJ IDEA → File → Settings → Plugins → 搜索 “Tongyi Lingma” → 点击 Install → 安装完成后重启 IDE。重启后右下角出现「灵码已就绪」提示，说明插件加载成功。

点击右上角灵码图标 → Sign in with Alibaba Cloud → 扫码授权。【必须完成登录，否则后续所有生成操作均返回空或报错】

登录成功后，面板右上角会显示用户昵称和在线状态。

为单个接口方法生成 Swagger 注释

将光标放在目标方法名正上方空白行（例如 public ResponseEntity<User> createUser() 上方），按快捷键 Alt+Enter → 选择 “Generate Swagger documentation” → 回车确认。

通义灵码会自动解析方法签名、@RequestBody/@RequestParam 注解、参数类型及返回值，并生成带 @Operation、@Parameter、@ApiResponse 的完整 OpenAPI 3 风格注释块。若方法含 DTO 参数，它还会递归扫描字段，自动添加 @Schema 或 @Parameter 描述。

注意：DTO 类必须已编译通过且在当前项目 classpath 中可见，否则字段类型将被标注为 object。

批量为整个 Controller 类生成文档注释

方法一：光标置于类名所在行（如 public class UserController）→ 快捷键 Ctrl+Shift+D（Windows）或 Cmd+Shift+D（Mac）→ 等待 2～4 秒。

方法二：右键点击类名 → 选择「AI 生成 Swagger 注解」。

方法三：在编辑器任意空白处输入自然语言指令：“给这个 UserController 补全 Swagger 注解，要求所有 POST 接口的请求体参数都带 required = true，错误响应统一标注 400 和 500”，再按 Ctrl+Enter 提交。

生成标准 Markdown 格式技术文档

第一步：将光标定位在 Controller 类名、方法定义行或整个类的起始大括号处——这是触发上下文感知的关键位置，光标放错会导致生成内容脱离实际结构。

第二步：右键 → 选择「通义灵码」→ 点击「生成技术文档」。

第三步：等待 3～8 秒，右侧弹出预览窗口。文档默认含「概览」「输入参数」「返回说明」「调用示例」「注意事项」五部分，示例代码自动匹配当前项目使用的 SDK 版本和风格。

第四步：点击预览页右上角「Insert to Editor」按钮，文档将填充至当前编辑器光标所在位置。

从 OpenAPI YAML/JSON 文件生成接口文档

复制 Swagger UI 中导出的 /openapi.json 内容片段（至少含 paths 和 components），新建 openapi.yml 文件粘贴保存 → 右键该文件 → 「通义灵码」→ 「从 OpenAPI 生成技术文档」。

这一步不依赖 Java 源码，但要求 YAML/JSON 符合 OpenAPI 3.0 规范，否则字段解析可能中断或缺失。