# API Docs

> Generate API documentation from source code with JSDoc and OpenAPI support

- Skill: `ruvnet/api-docs` (Agent Skill)
- Install (CLI): `npx skillmds@latest add ruvnet/api-docs`
- Raw SKILL.md: https://api.skillmd.com/api/skills/ruvnet/api-docs/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Docs & Writing
- Author: ruvnet (https://skillmd.com/u/ruvnet)
- Updated: 2026-09-09
- Page: https://skillmd.com/skills/ruvnet/api-docs

---


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", 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

---

**Source:** [`ruvnet/ruflo`](https://github.com/ruvnet/ruflo) → `plugins/ruflo-docs/skills/api-docs/SKILL.md`