applyDocfyMetadata(document, options?)

Mescla a metadata de build-time produzida pelo plugin do CLI nestjs-docfy num documento OpenAPI já buildado.

Uso

Chame logo após SwaggerModule.createDocument(), no mesmo ponto do lifecycle onde o output de um patch-spec manual seria mesclado, exceto que isso roda automaticamente a cada build em vez de uma etapa separada de CLI. Ver O plugin do CLI para o quadro completo, incluindo registrar no 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);

Options

Option	Type	Default	Description
`metadataPath`	`string`	`docfy-metadata.json` ao lado do arquivo de entrada	Path absoluto para o arquivo de metadata que o plugin escreveu.
`strict`	`boolean`	`false`	Lança exceção em vez de avisar quando o arquivo de metadata está ausente ou não parseia. Reflete `DocfyModule.forRoot({ strict })`.

Fail-open by default

Se o arquivo de metadata não for encontrado (por exemplo, o plugin não está registrado no nest-cli.json), ele avisa e retorna o documento sem mudanças, o mesmo default fail-open do DocfyModule.forRoot().