从事API开发的工程师都深有体会，编写文档往往是件令人头疼的事——即便代码逻辑已经通过测试，仍需回头补充参数说明、请求体示例及状态码映射。更麻烦的是，文档与代码时常不同步，一旦修改逻辑就得手动更新一遍。CodeGeeX提供了一套实用的解决方案，包含三种方式，全面覆盖从单文件到跨模块，再到项目级文档的自动生成场景。

试想这样一个场景：你刚刚完成一批Python或TypeScript的HTTP接口函数，急需快速生成结构统一、字段精准、可直接用于Swagger UI渲染的API文档。手动补全？效率太低。复制粘贴？容易出错。最理想的方式是借助工具自动理解代码，生成的内容与当前代码逻辑严格保持一致，且参数说明、示例JSON、状态码映射无一遗漏。

使用快捷键批量生成单文件内所有函数的API文档

如果你已经完成了核心接口函数的编写，但整个文件中没有任何docstring，那么这是最便捷的方式。只需一次触发，当前打开文件中所有可识别的函数都会被自动扫描。操作非常简便：将光标置于任意一个待生成文档的函数名左侧空白处（注意不要选中任何文本），然后按下 Ctrl+Shift+D（Windows/Linux）或 Cmd+Shift+D（Mac）。CodeGeeX将自动扫描文件中所有符合签名规范的函数，并在每个函数上方插入Markdown风格的docstring，使用 """ 包裹。如果某个函数已存在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”，粘贴到侧边栏输入框底部，按回车键即可。

方法二：上传压缩包解析整个模块

如果文件数量较多，逐个复制较为繁琐，可以直接将整个路由目录打包成zip文件上传。点击侧边栏右上角的“