通义灵码如何生成接口文档：Swagger文档自动生成方法

在IntelliJ IDEA开发环境中，通义灵码能够高效生成Spring Boot Controller的Swagger注释、Markdown文档及OpenAPI YAML文件。只需安装插件并登录阿里云账号，即可通过快捷键或右键菜单快速生成各类文档，大幅提升开发效率。

当Spring Boot项目中的Controller缺少Swagger注解时，手动添加@Api、@ApiOperation等注解既耗时又容易出错。通义灵码通过智能分析代码结构，能在数秒内自动生成完整且规范的Swagger文档注释。

在 IntelliJ IDEA 中启用通义灵码

进入Settings → Plugins界面，搜索"Tongyi Lingma"插件并安装。安装完成后重启IDE，当右下角显示「灵码已就绪」提示时，表示插件已成功加载。

使用前需完成阿里云账号登录：点击右上角灵码图标，选择Sign in with Alibaba Cloud进行扫码授权。请注意，未登录状态下所有生成功能将无法使用。

【必须完成登录，否则后续所有生成操作均返回空或报错】

为单个 Controller 方法生成 Swagger 注释

将光标定位到目标方法名上方的空白行，按下Alt+Enter组合键，选择"Generate Swagger documentation"选项即可。

插件会自动分析方法的签名、参数类型、返回值等信息，生成符合Swagger 2.0规范的完整注释块，包含@Api、@ApiOperation等注解。对于DTO参数，还会自动添加@ApiModelProperty注解，无需手动查看字段定义。

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

第一种方式：将光标置于类名所在行，使用Alt+Enter快捷键，选择"Generate Swagger documentation for class"。

第二种方式：右键点击类名，选择Lingma → Generate Swagger documentation。

该功能会为整个类生成统一的文档注释，包含类级别的@Api注解和每个方法的详细说明，同时会自动跳过已有Swagger注释的方法，避免重复生成。

从 Controller 直接导出 Markdown 接口文档

第一步：右键点击Controller文件，选择"Lingma → Export as Markdown API doc"。

第二步：在弹出的窗口中勾选"Include request/response examples"选项，点击Export按钮。

第三步：选择保存路径，生成的Markdown文件包含完整的接口文档结构，包括请求方式、参数表格、响应示例等详细信息，可直接用于团队协作。

生成 Swagger YAML 文件供 CI/CD 使用

在项目根目录下打开Terminal，执行命令：lingma swagger export --controller com.example.api.UserController --output openapi.yaml。

该命令会生成符合OpenAPI 3.0.3规范的YAML文件，包含完整的API定义，可直接用于CI/CD流程或导入API网关。

通义灵码为Spring Boot项目提供了从代码注释到API文档的一站式解决方案，通过自动化文档生成显著提升了开发效率，确保文档与代码保持同步更新。