# Api Docs

> Genera documentación de API a partir del código fuente, con soporte para JSDoc y OpenAPI.

Fuente: https://skillsagentes.com/skills/ruvnet/ruflo/api-docs
Markdown: https://skillsagentes.com/skills/ruvnet/ruflo/api-docs.md

Repositorio: https://github.com/ruvnet/ruflo
Autor: ruvnet
Licencia: MIT
Actualizado: el mes pasado
Coste de contexto: 19 tok instalada, 239 tok al activarse, 239 tok con todos los archivos del bundle
Bundle: 1 archivo, 955 B
Permisos que pide: bash(npx *) mcp__plugin_ruflo-core_ruflo__hooks_worker-dispatch read write grep

## Instalación

Un skill son archivos markdown: los mismos archivos valen para cualquier agente y lo único que cambia es el directorio de destino, es decir la bandera `--agent`. Añade `-g` para instalarlo en todos los proyectos de la máquina.

```bash
# Claude Code
npx -y skills add ruvnet/ruflo --skill api-docs --agent claude-code
# Cursor
npx -y skills add ruvnet/ruflo --skill api-docs --agent cursor
# Codex
npx -y skills add ruvnet/ruflo --skill api-docs --agent codex
# Gemini CLI
npx -y skills add ruvnet/ruflo --skill api-docs --agent gemini
# Windsurf
npx -y skills add ruvnet/ruflo --skill api-docs --agent windsurf
# Cline
npx -y skills add ruvnet/ruflo --skill api-docs --agent cline
```

## Qué hace

- Escanea las funciones, clases e interfaces públicas exportadas en código TypeScript/JavaScript.
- Extrae anotaciones JSDoc (@param, @returns, @throws, @example) y añade JSDoc a las APIs públicas sin documentar.
- Genera definiciones OpenAPI 3.0 para endpoints HTTP.

## Cuándo usarla

- Al documentar los exports públicos de un módulo TypeScript/JavaScript.
- Al generar una spec OpenAPI para endpoints HTTP existentes.

## Qué la activa

- "Genera la documentación de la API en src/api"
- "Añade JSDoc a las funciones públicas sin documentar"

## Archivos

- SKILL.md — 955 B

## SKILL.md

Reproducido tal cual desde ruvnet/ruflo bajo MIT. Esta sección es el documento original y está en inglés.

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

## Dónde encaja

- Categoría: [Documentos](https://skillsagentes.com/categorias/documentos.md) — Lee, escribe y transforma archivos PDF, DOCX, XLSX y PPTX.
- Creador: [ruvnet](https://skillsagentes.com/creators/ruvnet.md) — 275 skills en el directorio
- [Todas las skills](https://skillsagentes.com/skills.md)
- [Ranking de instalaciones](https://skillsagentes.com/ranking.md)

## Otras skills del mismo repositorio

- [Harness Gepa](https://skillsagentes.com/skills/ruvnet/ruflo/harness-gepa.md): Inspecciona y audita genomas GEPA: carga y valida un genoma, renderiza el system prompt que compila, o clasifica los modos de fallo de una transcripción de ejecución.
- [Deepseek Reason](https://skillsagentes.com/skills/ruvnet/ruflo/deepseek-reason.md): Completion en modo razonamiento contra deepseek-reasoner (R1) de DeepSeek. Devuelve el chain-of-thought por separado de la respuesta final. Lee DEEPSEEK_API_KEY y degrada si falta o la API no responde.
- [Deepseek Chat](https://skillsagentes.com/skills/ruvnet/ruflo/deepseek-chat.md): Completion de un solo turno contra el modelo deepseek-chat de DeepSeek vía /v1/chat/completions. Lee DEEPSEEK_API_KEY y degrada con status:degraded si falta o la API no responde. Para tareas sin razonamiento.
- [Adr Index](https://skillsagentes.com/skills/ruvnet/ruflo/adr-index.md): Construye o reconstruye el índice de ADRs y su grafo de dependencias ejecutando scripts/import.mjs, en vez de cientos de llamadas MCP.
- [Agntcy Status](https://skillsagentes.com/skills/ruvnet/ruflo/agntcy-status.md): Muestra el estado de la integración AGNTCY/SLIM/CASA: si los paquetes están instalados, qué transporte está activo y si el enforcement de CASA está habilitado.

---

Skills Agentes · [Índice de páginas en markdown](https://skillsagentes.com/sitemap.md) · [Inicio](https://skillsagentes.com/index.md)