用Cursor开发Node.js接口文档需安装TypeDoc插件、配置typedoc.json（指定entryPoints、添加markdown插件、删除excludePrivate）、为Express路由添加含@route/@group/@param等的JSDoc注释，并通过命令生成HTML文档。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜
用Cursor开发Node.js接口文档需要把代码注释、路由定义和类型信息自动转换成可读的API说明页面，避免手动维护文档与代码脱节。
安装并启用TypeDoc插件
打开Cursor设置→Extensions→搜索“typedoc”→点击Install安装官方TypeDoc插件。该插件依赖Node.js环境，【请确保系统已安装16.14+版本的Node.js】，否则生成命令会报错退出。
安装完成后重启Cursor，插件图标将出现在左侧活动栏底部。
在项目中初始化TypeDoc配置
在项目根目录终端运行：npx typedoc --init。
执行后会生成typedoc.json配置文件，默认输出格式为html，但Node.js接口文档更需突出路由路径和请求响应结构，因此需手动修改三项：将"entryPoints"指向src/routes/*.ts（或你存放路由定义的实际路径）；把"plugin"数组加入"typedoc-plugin-markdown"（用于后续导出Markdown版）；【务必删掉"excludePrivate": true这一行】，否则带@private标记的中间件参数不会出现在文档中。
给Express路由添加JSDoc注释
方法一：基础路径+方法标注
在router.get('/users', ...)上方写三行注释：
/**
* @route GET /users
* @group User - 用户管理接口
*/
方法二：完整接口描述（推荐）
对需要详细说明的接口，补充请求参数和响应示例：
/**
* @route GET /users
* @group User
* @param {string} query.page - 页码，默认为1
* @param {string} query.limit - 每页数量，默认为10
* @success {object} 200 - 返回用户列表数组
* @successExample {json} Success-Response:
* HTTP/1.1 200 OK
* [{ "id": 1, "name": "Alice" }]
*/
注意：@param必须明确写query.或body.前缀，否则TypeDoc无法识别参数位置，生成文档时会丢失这部分内容。
一键生成HTML文档
第一步：确认当前工作区已打开Node.js项目根目录。
第二步：按下Ctrl+Shift+P（Windows/Linux）或Cmd+Shift+P（macOS），输入“TypeDoc: Generate Documentation”，回车。
第三步：等待右下角弹出“Documentation generated successfully”，此时项目根目录下会出现docs文件夹。
第四步：在Cursor中右键点击docs/index.html→选择“Reveal in Explorer”→双击打开即可本地浏览完整接口文档。这一步操作起来很简单，直接把文件拖进去就行。
