applyDocfyMetadata(document, options?)

Combina los metadatos generados en tiempo de compilación por el plugin de CLI de nestjs-docfy en un documento OpenAPI ya construido.

Uso

Llama a esto justo después de SwaggerModule.createDocument(), en el mismo punto del ciclo de vida donde se fusionaría manualmente la salida de patch-spec, salvo que esto se ejecuta automáticamente en cada build en vez de un paso de CLI aparte. Consulta El plugin de CLI para el panorama completo, incluido cómo registrarlo en nest-cli.json.

import { NestFactory } from '@nestjs/core';
import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger';
import { applyDocfyMetadata } from 'nestjs-docfy';

const app = await NestFactory.create(AppModule);

const document = SwaggerModule.createDocument(app, new DocumentBuilder().build());
SwaggerModule.setup('api', app, applyDocfyMetadata(document));

await app.listen(3000);

Opciones

Option	Type	Default	Description
`metadataPath`	`string`	`docfy-metadata.json` junto al archivo de entrada	Ruta absoluta al archivo de metadatos que escribió el plugin.
`strict`	`boolean`	`false`	Lanza un error en vez de avisar cuando el archivo de metadatos falta o no se puede parsear. Refleja `DocfyModule.forRoot({ strict })`.

Fail-open by default

Si no se encuentra el archivo de metadatos (por ejemplo, el plugin no está registrado en nest-cli.json), avisa y devuelve el documento sin cambios, el mismo comportamiento fail-open por defecto que DocfyModule.forRoot().