后端与数据库

api-docs

ruvnet/ruflo

Generate API documentation from source code with JSDoc and OpenAPI support

  • 892 次安装
  • 8万 星标
  • 收录于

安装命令

npx skills add https://github.com/ruvnet/ruflo --skill api-docs

SKILL.md

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