applyDocfyMetadata(document, options?)

Voegt de build-time metadata van de nestjs-docfy CLI-plugin samen met een al gebouwd OpenAPI-document.

Gebruik

Roep dit meteen na SwaggerModule.createDocument() aan, op hetzelfde punt in de lifecycle waar een handmatig gedraaide patch-spec-output zou worden samengevoegd, alleen loopt dit nu automatisch mee bij elke build in plaats van als losse CLI-stap. Zie De CLI-plugin voor het volledige plaatje, inclusief registratie 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);

Opties

Option	Type	Default	Description
`metadataPath`	`string`	`docfy-metadata.json` naast het entry-bestand	Absoluut pad naar het metadata-bestand dat de plugin heeft weggeschreven.
`strict`	`boolean`	`false`	Gooi een fout in plaats van een waarschuwing wanneer het metadata-bestand ontbreekt of niet te parsen is. Spiegelt `DocfyModule.forRoot({ strict })`.

Fail-open by default

Als het metadata-bestand niet gevonden wordt (bijvoorbeeld omdat de plugin niet geregistreerd is in nest-cli.json), geeft dit een waarschuwing en levert het document ongewijzigd terug, dezelfde fail-open standaard als DocfyModule.forRoot().