generate_api_docs
Generates API docs from actual NestJS controllers, DTOs, and error catalogs, creating per-module contracts, Mermaid diagrams, an index, architecture docs, and optional Postman collections.
Instructions
Genera la documentacion de la API LEYENDO EL CODIGO REAL (controllers, DTOs, catalogos de error), nunca de memoria. Siempre: contrato por modulo (src//contracts/.api.md), diagrama Mermaid sequenceDiagram por modulo (src//diagrams/.flow.mmd) e indice docs/api/README.md, mas docs/ARCHITECTURE.md (diagrama Mermaid architecture-beta; siempre, no se pregunta). Opt-in (el agente PREGUNTA al usuario): postman=true crea docs/api/middleware.postman_collection.json (una coleccion, una carpeta por modulo, fusion sin tocar las demas). Idempotente y determinista; add_use_case y record_architecture la refrescan solos.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| modules | No | Solo estos modulos (carpetas bajo src/). Por defecto todos los que tengan controllers. | |
| postman | No | Crear/actualizar docs/api/middleware.postman_collection.json (una coleccion, una carpeta por modulo, fusion sin tocar las demas). El agente debe PREGUNTAR al usuario antes de poner true. Si la coleccion ya existe se actualiza siempre. | |
| projectRoot | Yes | Ruta absoluta de la raÃz del servicio NestJS destino donde se escriben los archivos. | |
| architecture | No | Crear/actualizar docs/ARCHITECTURE.md con un diagrama Mermaid architecture-beta. Se genera siempre (no se pregunta al usuario); pon false solo si no se quiere. |