Fitten Code 插件可自动为 Express/Fastify 路由生成符合 OpenAPI 规范的 JSDoc 注释:安装启用后,定位函数名前执行“Fitten: Generate API Doc”,自动提取路径/查询/请求体参数;支持 @status Tab 补全错误响应,批量添加常见错误码;最后通过 npx fitten-code export 导出 OpenAPI JSON。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

你需要在 TypeScript 项目中为 Express 或 Fastify 路由快速补全符合 OpenAPI 规范的 JSDoc 注释,避免手写 @param、@returns 时漏字段或格式错乱。
安装并启用 Fitten Code 插件
打开 VS Code → 点击左侧扩展图标 → 搜索 “Fitten Code” → 点击安装 → 安装完成后重启编辑器。
插件默认启用,无需额外配置。如果未生效,检查右下角状态栏是否显示 “Fitten Code: Ready”,【未显示则说明插件未激活,需点击状态栏手动启用】。
生成基础路由注释
将光标定位在路由处理函数名正前方(例如 const getUser = (req, res) => {)→ 按 Ctrl+Shift+P(Windows/Linux)或 Cmd+Shift+P(Mac)→ 输入 “Fitten: Generate API Doc” → 回车执行。
插件会自动识别 req、res 类型,提取路径参数、查询参数、请求体结构(基于已定义的 interface 或 type),生成带 @openapi 标签的 JSDoc 块。这一步不依赖 tsconfig.json 中的 “compilerOptions.types”,但【若 handler 函数参数未标注类型,如 req: Request,将无法推导出 query/body 字段】。
Fitten Code 1.0.3是一款由清华博士团队打造的AI编程助手,基于国产计图(Jittor)深度学习框架开发。它支持VS Code、JetBrains系列等主流IDE及80多种编程语言。核心功能包括智能代码补全、注释生成、代码解释、Bug检测、单元测试生成等,旨在全方位提升开发效率。该工具对个人用户免费开放。
补充响应体与错误码注释
方法一:自动推导成功响应
插件默认把函数返回值类型(如 Promise
方法二:手动添加 HTTP 状态码分支
在生成的 JSDoc 块内,光标置于最后一行下方 → 输入 @status 404 → 按 Tab 键 → 输入 “User not found” → 再按 Tab → 输入对应错误响应类型(如 ErrorResponse)。此操作会插入完整 @response 404 条目,包含 description 和 content。
方法三:批量注入常见错误码
选中多个路由函数 → 右键 → 选择 “Fitten: Add Common Error Responses” → 勾选 400/401/403/404 → 确认。该操作会为每个函数追加对应 @response 块,但【不会覆盖已有同状态码条目,重复执行将产生冗余】。
导出为 OpenAPI JSON 文件
第一步:确保项目根目录存在 tsconfig.json,且 “include” 字段包含所有含 API 注释的 .ts 文件路径。
第二步:在 VS Code 终端中执行 npx fitten-code export --output ./openapi.json。
第三步:等待命令行输出 “✅ Exported to ./openapi.json” 后,文件即生成完毕。

















