DocfyUiModule.setup(mountPath, app, options?)

Uso

Funciona tanto com Express (@nestjs/platform-express) quanto com Fastify (@nestjs/platform-fastify). No Fastify, a distribuição dos assets estáticos exige a dependência peer opcional @fastify/static (npm install @fastify/static) — o mesmo pacote que o próprio @nestjs/swagger usa para suportar o Swagger UI no Fastify.

import { NestFactory } from '@nestjs/core';
import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger';
import { DocfyUiModule } from 'nestjs-docfy';

const app = await NestFactory.create(AppModule);

DocfyUiModule.setup('/docs', app); // before SwaggerModule.setup; see staticSpecPath below

const document = SwaggerModule.createDocument(app, new DocumentBuilder().build());
SwaggerModule.setup('api', app, document); // exposes /api-json, which docfy-ui fetches by default

await app.listen(3000);

Visite /docs: nenhuma configuração adicional necessária, já que docfy-ui busca /api-json same-origin por default.

Options

staticSpecPath (obrigatório se sua app builda com webpack: true)

O pipeline de metadata em runtime do DocfyModule não consegue aplicar docs files lá, então o /api-json ao vivo vai ficar sem tudo que docs files adicionariam. Gere um documento com patch antes:

npx nestjs-docfy patch-spec --spec http://localhost:3000/api-json --out openapi.patched.json

E sirva ele:

DocfyUiModule.setup('/docs', app, { staticSpecPath: './openapi.patched.json' });

Chame isso antes de SwaggerModule.setup(): o Express resolve rotas em ordem de registro, então o documento estático com patch tem precedência sobre o vivo para qualquer request a /api-json. No Fastify, o SwaggerModule.setup() registrar sua própria rota /api-json junto com essa opção causa FST_ERR_DUPLICATED_ROUTE no startup — ordem de registro não ajuda nesse caso, então aponte o SwaggerModule.setup() para outro jsonDocumentUrl (ou passe { raw: false }) ao combinar com staticSpecPath no Fastify.

Caveat: BrowserRouter e mount path