CodeGeeX 提供三种 API 文档生成方式：快捷键批量生成单文件函数 docstring；侧边栏问答提取跨文件 OpenAPI YAML；CLI 工具生成带超链接索引的 README.md。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜
你需要为 Python 或 TypeScript 编写的 HTTP 接口函数快速生成结构统一、字段准确、可直接用于 Swagger UI 渲染的 API 文档，避免手动补全参数说明、请求体示例和响应状态码映射，同时确保文档内容与当前代码逻辑严格一致。
用快捷键批量生成单文件内所有函数文档
该方法适合已写完核心接口函数、但尚未添加任何 docstring 的中型脚本或模块，一次触发即可覆盖当前打开文件中全部可识别函数。
将光标置于任意一个待文档化的函数名左侧空白处（不要选中文本）。
按下 Ctrl+Shift+D（Windows/Linux）或 Cmd+Shift+D（Mac），CodeGeeX 会自动扫描当前文件中所有符合签名规范的函数并逐个生成文档块。
生成过程不修改原有代码结构，仅在函数上方插入以 """ 包裹的 Markdown 风格 docstring；若函数已有 docstring，默认跳过不覆盖，防止误删人工编写内容。
检查生成结果中是否包含 request body 示例 JSON 和 status code 映射表——若缺失，说明函数缺少类型注解或 Pydantic/BaseModel 定义，需先补全再重试。
通过侧边栏问答提取跨文件 API 元数据
当项目分散在多个文件（如 routes/、controllers/）、且部分函数缺乏类型提示时，此方式可绕过静态解析限制，直接驱动模型理解语义。
方法一：自然语言提问 + 批量代码拖入
点击 VS Code 左侧活动栏中的 CodeGeeX 图标，打开侧边栏面板。
CodeGeeX 2.21.0是智谱AI推出的AI编程助手版本，对Inline Chat功能进行了重大优化，包括UI设计升级、支持流式输出以提升响应速度，并新增“查看思路”按钮以便理解代码原理。同时，该版本在编辑器中新增CodeLens控件，支持一键“解释”代码或“添加注释”。目前该工具对个人开发者免费开放。
输入问题：“请从以下 Flask 路由代码中提取全部 GET/POST 接口，生成 OpenAPI v3.0.3 YAML 格式文档，包含 path、method、summary、requestBody schema（含 required 字段）、responses 200/400 描述。”
按住 Ctrl（Windows/Linux）或 Cmd（Mac），在编辑器中框选多个路由函数 → 右键 → “Copy as Plain Text” → 粘贴至侧边栏输入框底部。
方法二：上传压缩包解析整个模块
点击侧边栏右上角“? 附加文件”按钮 → 选择包含 __init__.py 的完整路由目录压缩为 zip 后上传。
用 CLI 工具生成含接口概览表的 README.md
该方式适用于已完成多模块开发、需要对外交付项目级文档的场景，能自动生成带表格索引的顶层说明文件。
第一步：确保已安装 CodeGeeX CLI 工具。执行 pip install codegeex-cli 或 npm install -g codegeex-cli。
第二步：进入项目根目录，运行命令：codegeex readme --input src/ --output docs/README.md --title "My API Service"。
第三步：CLI 自动扫描所有 Python/TypeScript 接口文件，提取路径、方法、摘要与参数数量，生成带超链接的接口概览表。
第四步：打开生成的 docs/README.md，确认表格中每行对应一个真实接口，且 【path 字段必须与实际路由装饰器完全一致，否则链接跳转失效】。
