关于 api-docs
api-docs 是为 TypeScript 和 JavaScript API 编写文档的技能，可扫描公开导出、解析 JSDoc、补全文档，并为 HTTP 端点生成 OpenAPI 3.0 定义。
主要功能
- 01扫描公开函数、类和接口
- 02解析 JSDoc 注解
- 03补充缺失的 JSDoc
- 04生成 OpenAPI 3.0 定义
适用场景
- 01为缺少文档的公开导出编写说明
- 02从源代码生成 API 参考
- 03用 OpenAPI 描述 HTTP 端点
MCP 相关
该技能通过 MCP hook worker 派发文档任务，并指定 document 触发器和 API 范围。
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/api-docs确认已加载。
详细介绍
从 TypeScript/JavaScript 源代码生成 API 文档：
- 扫描导出项：查找所有公共函数、类和接口
- 提取 JSDoc：解析
@param、@returns、@throws、@example注解 - 生成缺失的文档：为未编写文档的公共 API 添加 JSDoc
- OpenAPI 规范：为 HTTP 端点生成 OpenAPI 3.0 定义
通过 MCP 调用：mcp__plugin_ruflo-core_ruflo__hooks_worker-dispatch({ trigger: "document", scope: "api" })
约定：
- 每个公共导出项都必须有 JSDoc 注释
- 包含带类型和说明的
@param - 包含带类型和说明的
@returns - 针对已知错误情况包含
@throws - 针对不明显的用法包含
@example
评论
支持 Markdown