applyDocfyMetadata(document, options?)

Unisce i metadati generati in fase di build dal plugin CLI di nestjs-docfy a un documento OpenAPI già costruito.

Utilizzo

Chiamalo subito dopo SwaggerModule.createDocument(), nello stesso punto del ciclo di vita in cui verrebbe unito l'output di un patch-spec eseguito a mano, con la differenza che questo gira automaticamente a ogni build invece che come step CLI separato. Vedi Il plugin CLI per il quadro completo, incluso come registrarlo in 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);

Opzioni

Option	Type	Default	Description
`metadataPath`	`string`	`docfy-metadata.json` accanto al file di ingresso	Percorso assoluto del file di metadati scritto dal plugin.
`strict`	`boolean`	`false`	Solleva un errore invece di limitarsi ad avvisare quando il file di metadati manca o non è leggibile. Rispecchia `DocfyModule.forRoot({ strict })`.

Fail-open by default

Se il file di metadati non viene trovato (ad esempio perché il plugin non è registrato in nest-cli.json), viene stampato un avviso e il documento è restituito invariato, lo stesso comportamento fail-open di default di DocfyModule.forRoot().