applyDocfyMetadata(document, options?)
Scala metadane wygenerowane podczas builda przez plugin CLI nestjs-docfy z już zbudowanym dokumentem OpenAPI.
Użycie
Wywołaj to zaraz po SwaggerModule.createDocument(), w tym samym miejscu cyklu życia, w którym scalałbyś ręcznie uruchomiony wynik patch-spec, z tą różnicą, że to dzieje się automatycznie przy każdym buildzie zamiast osobnego kroku CLI. Pełny obraz, wraz z rejestracją w nest-cli.json, znajdziesz w The CLI plugin.
ts
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);Opcje
| Option | Type | Default | Description |
|---|---|---|---|
metadataPath | string | docfy-metadata.json obok pliku wejściowego | Bezwzględna ścieżka do pliku metadanych zapisanego przez plugin. |
strict | boolean | false | Rzuca wyjątek zamiast ostrzegać, gdy plik metadanych nie istnieje lub nie da się go sparsować. Odpowiednik DocfyModule.forRoot({ strict }). |
Fail-open by default
Jeśli plik metadanych nie zostanie znaleziony (na przykład plugin nie jest zarejestrowany w nest-cli.json), funkcja ostrzega i zwraca dokument bez zmian, ten sam domyślny tryb fail-open co DocfyModule.forRoot().