Generate API Documentation from Code

v20260716

api-docs

Automatically generates comprehensive API documentation from existing TypeScript or JavaScript source code. It scans public exports, parses detailed JSDoc annotations (including parameters, returns, and throws), and can generate standardized OpenAPI 3.0 specifications for HTTP endpoints, ensuring robust and up-to-date API references.

API Documentation TypeScript JavaScript JSDoc OpenAPI Code Generation

Get Skill

311 downloads

Overview

Generate API documentation from TypeScript/JavaScript source:

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

Dispatch via MCP: mcp__plugin_ruflo-core_ruflo__hooks_worker-dispatch({ trigger: "document", scope: "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 v20260716

Size 955B

Source ruvnet/ruflo

Updated At 2026-07-18