CodeGeeX支持三种自动生成Swagger文档方式：①快捷键Ctrl+Shift+D（Mac为Cmd+Shift+D）触发，需函数带类型注解或标准docstring且含路由装饰器；②侧边栏问答交互生成YAML，适用于注释稀疏项目；③Spring Boot项目通过/api-docs导出JSON再转HTML。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜
你需要在不手动编写 YAML 或 Markdown 的前提下，让 CodeGeeX 自动产出结构完整、字段准确、能直接用于 Swagger UI 渲染的 RESTful 接口文档，且文档内容必须与当前代码逻辑严格一致，不能遗漏 path、method、requestBody 或 response schema。
用快捷键触发内置文档生成（推荐首选）
这一步操作起来很简单，直接把光标停在函数名上按组合键就行，但前提是函数本身已带类型注解或标准 docstring，否则生成内容会空泛。
将光标置于目标函数定义行首（例如 def create_user(...):），确保该函数位于 Python/TypeScript/Java 文件中且语言模式已正确识别。
按下 Ctrl+Shift+D（Windows/Linux）或 Cmd+Shift+D（Mac），CodeGeeX 会立即分析函数签名、参数类型、返回值及已有注释。
生成的 Markdown 文档块自动插入在函数上方，包含 HTTP method、path（从路由装饰器或 URL 模式推导）、请求体字段列表、成功响应状态码与结构示例。若函数无 @app.route 或 @PostMapping 等路由声明，path 将留空或标记为“需手动补充”——【这是关键前提：没有显式路由定义，path 无法可靠推断】。
通过侧边栏问答提取 API 元数据（适用于注释稀疏的旧项目）
当代码里只有中文描述、没有类型提示、也没有标准 docstring 时，静态解析容易失效，此时必须靠自然语言交互驱动模型理解语义。
方法一：打开 VS Code 左侧 CodeGeeX 图标 → 在聊天框输入：“请根据以下 Flask 路由函数生成 OpenAPI v3.0.3 YAML 格式文档，要求包含请求体 JSON 示例、200 和 400 响应描述，并保留路径变量如 /users/{id}。”
CodeGeeX 2.21.0是智谱AI推出的AI编程助手版本，对Inline Chat功能进行了重大优化，包括UI设计升级、支持流式输出以提升响应速度，并新增“查看思路”按钮以便理解代码原理。同时，该版本在编辑器中新增CodeLens控件，支持一键“解释”代码或“添加注释”。目前该工具对个人开发者免费开放。
方法二：选中整个路由函数代码 → 拖拽进聊天输入框 → 点击发送。模型会基于上下文还原出完整的 paths、components、responses 结构。
复制返回的 YAML 内容 → 新建 openapi.yaml 文件 → 粘贴保存 → 用 Swagger Editor 打开验证是否可通过 schema 校验。注意：如果返回内容里出现 type: object 但未展开 properties，说明模型未识别出 Pydantic 模型或 DTO 类，需补全模型定义再重试。
从 Spring Boot 项目反向导出 Swagger JSON 并转 HTML 文档
此路径适用于 Java + Springfox/OpenAPI 集成完备的项目，目标是获得可离线浏览的 HTML 页面，而非编辑源码级文档。
第一步：确认 pom.xml 中已引入 springfox-swagger2（2.9.2+）与 springfox-swagger-ui 依赖，且配置类启用 @EnableSwagger2。
第二步：启动应用后访问 http://localhost:8080/v2/api-docs，检查返回 JSON 是否含 "paths" 字段且非空。若返回 404，请先确认是否配置了 Docket Bean 并设置了正确的扫描包路径。
第三步：执行命令导出 HTML：
java -jar swagger-codegen-cli.jar generate -i http://localhost:8080/v2/api-docs -l html -o ./docs/swagger-html
第四步：打开 ./docs/swagger-html/index.html 即可查看完整渲染效果。注意：该命令依赖本地存在 swagger-codegen-cli.jar 文件，版本建议使用 2.4.31 或 3.0.35，低版本可能无法解析 OpenAPI 3.x 兼容字段。
