Deploy: DocfyUiModule vs standalone

Sírvelo desde la misma app NestJS que expone la API, o como bundle estático en cualquier host estático.

Instalación

bash
npm install docfy-ui

Este paquete incluye un bundle estático precompilado (dist/): no hay código de servidor que instalar en un backend Node. Si usas nestjs-docfy, su DocfyUiModule.setup() ya envuelve esto por ti; si no, sirve la carpeta dist/ con cualquier servidor de archivos estáticos.

Via DocfyUiModule.setup()

La configuración más simple si tu backend es NestJS: deja que nestjs-docfy monte este paquete por ti.

ts
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

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);

Visita /docs: no hace falta configuración adicional.

Standalone (estático)

Sin nestjs-docfy, construye y sirve los assets estáticos tú mismo y apúntalo a cualquier documento OpenAPI:

bash
npm run build   # in this package, or use the prebuilt dist/ from npm

Sirve dist/ con cualquier host estático (ServeStaticModule de NestJS, Nginx, S3 + CloudFront, etc.), junto a o delante de la API que expone la spec.

Apuntando a una spec remota

Si la spec vive en un origen distinto, usa el override ?spec=<url> (consulta Configuration).