applyDocfyMetadata(document, options?)

Fusionne les métadonnées générées à la compilation par le plugin CLI de nestjs-docfy dans un document OpenAPI déjà construit.

Usage

Appelle-la juste après SwaggerModule.createDocument(), au même point du cycle de vie où une sortie de patch-spec lancée à la main serait fusionnée, sauf que ça tourne automatiquement à chaque build au lieu d'être une étape CLI séparée. Voir Le plugin CLI pour la vue d'ensemble, y compris comment l'enregistrer dans 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` à côté du fichier d'entrée	Chemin absolu vers le fichier de métadonnées écrit par le plugin.
`strict`	`boolean`	`false`	Lève une erreur au lieu d'avertir quand le fichier de métadonnées est manquant ou illisible. Reflète `DocfyModule.forRoot({ strict })`.

Fail-open by default

Si le fichier de métadonnées est introuvable (par exemple, le plugin n'est pas enregistré dans nest-cli.json), un avertissement est émis et le document est renvoyé inchangé, le même comportement fail-open que DocfyModule.forRoot().