docfy export

Por qué existe

Lo único que SwaggerModule.createDocument() necesita estructuralmente es una app Nest completamente inicializada: su contenedor de DI tiene que resolver cada provider antes de que exista metadata de ruta/DTO para introspeccionar.

Eso no requiere .listen(). No se abre ningún puerto.

En la práctica tampoco suele necesitar infraestructura viva: la mayoría de clientes TypeOrmModule, ioredis y kafkajs se conectan de forma perezosa en vez de bloquear el bootstrap, así que export suele funcionar con la base de datos, Redis y Kafka todos parados.

Uso

Proporciona un pequeño entry file (las mismas líneas que ya tiene tu main.ts, menos .listen()):

// docfy-export.ts
import { NestFactory } from '@nestjs/core';
import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger';
import { AppModule } from './app.module';

export default async function () {
  const app = await NestFactory.create(AppModule, { logger: false });
  const config = new DocumentBuilder().setTitle('My API').setVersion('1.0.0').build();
  const document = SwaggerModule.createDocument(app, config);
  return { app, document }; // `app` gets closed for you afterward
}

npx nestjs-docfy export --entry docfy-export.ts --out openapi.json

La salida informativa siempre va a stderr, nunca a stdout, así que es seguro hacer pipe: npx nestjs-docfy export --entry docfy-export.ts > openapi.json.

El contrato del entry file

El export por defecto es una función async que devuelve { app, document }. export la ejecuta en un proceso hijo, serializa document, y llama a app.close() por ti después.

Un entry .ts necesita ts-node como devDependency de tu proyecto (y también tsconfig-paths, para alias de path como @app/common).

Opciones