Skills Development API Documentation Generator

API Documentation Generator

v20261020
api-docs
Generate API documentation from TypeScript/JavaScript source code, extracting JSDoc annotations and producing OpenAPI 3.0 specs for HTTP endpoints.
Get Skill
349 downloads
Overview

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
Info
Category Development
Name api-docs
Version v20261020
Size 957B
Updated At 2026-10-21
Language