技能 编程开发 API 文档生成器

API 文档生成器

v20261020
api-docs
从 TypeScript/JavaScript 源代码生成 API 文档,解析 JSDoc 注解,并为 HTTP 端点生成 OpenAPI 3.0 规范。
获取技能
349 次下载
概览

Generate API documentation from TypeScript/JavaScript source:

  1. Scan exports: Find all public functions, classes, and interfaces
  2. Extract JSDoc: Parse @param, @returns, @throws, @example annotations
  3. Generate missing docs: Add JSDoc for undocumented public APIs
  4. OpenAPI spec: For HTTP endpoints, generate OpenAPI 3.0 definitions

Dispatch via MCP: mcp__plugin_ruflo-core_ruflo__hooks_worker-dispatch({ trigger: "document", context: "api" })

Conventions:

  • Every public export must have a JSDoc comment
  • Include @param with type and description
  • Include @returns with type and description
  • Include @throws for known error conditions
  • Include @example for non-obvious usage
信息
分类 编程开发
名称 api-docs
版本 v20261020
大小 957B
更新时间 2026-10-21
语言