qoder skill 一键提取 jsdoc 生成 openapi 3.0文档,支持 express/koa 项目自动补全 @route、@param 等字段;quest mode 构建 swagger ui 静态站点并输出 openapi.yaml;cli 可批量注入 swagger-ui-express 配置。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

你需要为 Node.js 项目快速生成可执行、格式统一的 API 文档,但手动补全 Swagger 注释易遗漏、JSDoc 风格不一致、导出文件路径混乱,导致前端对接反复确认、CI 流程卡在文档验证环节。
用 Qoder Skill 一键提取 JSDoc 生成 OpenAPI 3.0
该方法适用于已有 JSDoc 注释但未标准化的 Express/Koa 项目,Qoder 能自动识别注释中的 @route、@param、@returns 等字段并补全缺失结构。
1、确保项目中至少一个路由文件(如 routes/user.js)包含类似以下 JSDoc:
/*** @route GET /api/users* @group 用户管理* @param {string} page.query - 页码* @returns {Array} 200 - 用户列表*/
2、在 Qoder 编辑器中打开该文件 → 侧边聊天面板输入:【为这个路由文件生成 OpenAPI 3.0 文档】
3、等待 Skill 自动运行完成,生成结果将直接写入 ./docs/openapi.json 和配套 Markdown 概览页。
注意:若注释中缺少 @route 或 HTTP 方法声明,Skill 会跳过该函数,不会报错也不会伪造路径。
通过 Quest Mode 全流程驱动 Swagger UI 静态站点构建
当你需要本地预览、支持 HTML/YAML 双格式交付、且要求文档与代码变更联动时,Quest Mode 是唯一能闭环验证的方案。
第一步:点击顶部导航栏「Quest」→ 新建任务 → 命名为「Build Swagger for Node.js」
使用一条命令部署ProbeChain Rydberg测试网代理节点。自动注册为Agent(NodeType=1),免gas,支持macOS/Linux/Windows。触发词:/r
第二步:在任务描述框中输入:“基于当前 Express 项目生成 Swagger UI 静态页面,支持 localhost:8080/doc 查看,同时输出 openapi.yaml 到 ./dist/”
第三步:Qoder Agent 将自动识别 app.use('/api', router) 模式,扫描所有 require('./routes/*.js') 文件,并校验每个 handler 是否有 JSDoc 基础字段。缺少 @group 的接口会被归入「未分类」分组,但不会中断流程。
第四步:生成完成后,在右侧面板「Preview」标签页点击 Open in Browser,即可看到带交互式 Try-it-out 功能的 Swagger UI 页面。
第五步:检查 ./dist/openapi.yaml 是否存在,该文件已自动注入 host 和 schemes 字段,可直接用于 CI 中的 Swagger Validator 工具校验。
用 CLI 批量注入 Swagger 配置到 Express 应用
此方法专为已接入 swagger-ui-express 的项目设计,Qoder CLI 会直接修改代码,把文档服务挂载逻辑写进 app.js 或 server.js。
方法一:终端执行 qoder cli inject-swagger --format yaml --port 8080
方法二:若项目使用 TypeScript,追加 --ts 参数,CLI 将自动导入 swagger-jsdoc 类型定义并更新 import 语句。
这一步操作起来很简单,直接把文件拖进去就行——但必须确保当前目录下存在 package.json 且已安装 swagger-ui-express 和 swagger-jsdoc,否则 CLI 会终止并提示缺失依赖。
生成后,app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(spec)) 会被插入到 app.listen() 之前最近的 app.use() 块末尾,【不会覆盖已有中间件顺序】。










