CodeGeeX 提供三种 API 文档生成方式：① 快捷键 Ctrl+Shift+D 批量为单文件函数生成 Markdown docstring；② 侧边栏问答+代码拖入或上传 ZIP 提取跨文件 OpenAPI YAML；③ CLI 工具 codegeex readme 自动生成含接口概览表的 README.md。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜
你需要为多个 Python 或 TypeScript 接口函数快速生成结构统一、字段准确的 Markdown 格式 API 文档，避免逐个手动补全参数说明和响应示例，同时确保文档与最新代码逻辑一致。
用 CodeGeeX 内置快捷键批量生成单文件内所有函数文档
该方法适合已写完核心接口函数、但尚未添加任何 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 图标，打开侧边栏面板。
输入问题：“请从以下 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 后上传。
注意：上传前确保 zip 包根目录下有 pyproject.toml 或 setup.py，否则模型可能无法识别项目语言主干。
等待响应后，复制返回的 YAML 内容，保存为 openapi.yaml，用 Swagger Editor 验证 paths 是否覆盖全部 HTTP 动词与路径变量。
调用 CLI 工具对整个项目生成 README + API 概览表
第一步：安装 CLI 工具
在终端执行 pip install codegeex-cli，运行 codegeex --version 确认版本不低于 0.3.2。
第二步：进入项目根目录
确保当前路径下存在 pyproject.toml 或 package.json，且源码位于 src/ 或 app/ 子目录中。
第三步：执行批量生成命令
运行：codegeex readme --lang zh --template openapi-overview --primary-lang python。
该命令会自动扫描所有 .py 文件中的 @app.route、@router.get 等装饰器定义的端点，提取 method/path/summary 并汇总为 README.md 中的“API 接口概览”表格，同时保留原始 README 的其他章节不动。
第四步：验证生成位置
生成的 README.md 默认输出到项目根目录；若已有同名文件，不会覆盖，而是另存为 README_codegeex_20260618.md，避免误删人工维护内容。
