swagger

Swagger / OpenAPI reference

@nestjs/swagger is an optional peer of @kavo/nest — install it and every generated route documents itself automatically; leave it out and @Kavo costs nothing extra. No config flag turns this on or off: Kavo detects the package at runtime (createRequire(...).require("@nestjs/swagger"), cached, never throws if absent) and documents routes only when it's there. Full detail: docs/internals/architecture/10-nestjs-integration.md §4.

Install

npm install @nestjs/swagger

That's the only step — no @Kavo config option, no KavoModule option. Existing @Kavo-decorated controllers pick up documentation the next time the app boots with @nestjs/swagger present.

Wiring the docs endpoint (main.ts)

This is plain Nest/Swagger, not Kavo-specific — SwaggerModule still needs to be told to build and serve a document:

import { NestFactory } from "@nestjs/core";
import { DocumentBuilder, SwaggerModule } from "@nestjs/swagger";
import { AppModule } from "./app.module.js";

async function bootstrap(): Promise<void> {
  const app = await NestFactory.create(AppModule);

  const document = SwaggerModule.createDocument(
    app,
    new DocumentBuilder().setTitle("My API").setVersion("1.0.0").build(),
  );
  SwaggerModule.setup("docs", app, document); // → GET /docs

  await app.listen(3000);
}

void bootstrap();

What's documented automatically, per generated route

Piece	Source
Operation id	<Entity>_<operationId> (e.g. User_findMany)
:id path param	Every operation with an id in its route
Query params on list routes	filter/sort/fields/pagination/include shape (doc 05)
Request body schema	The entity's registered DTO class for that slot (ApiBody) — see dto-slots
Error response schemas	Problem-details shape for 400/404, from the error catalog — see error-handling