decorators/SwaggerExample.ts

nestia · packages/core/src/decorators/SwaggerExample.ts · typescript · MIT
integration

Decorators to populate Swagger examples for NestJS controllers.

// Source: https://github.com/samchon/nestia | License: MIT | Copyright 2021 Jeongho Nam
// Provided via justclaw.it.com; keep this notice with the code.
/**
 * Attach example values to Swagger documents.
 *
 * `SwaggerExample` is a namespace of decorators that attach example values to
 * controller methods (request/response bodies, parameters), so that
 * `@nestia/sdk`'s Swagger generator can populate the `example` / `examples`
 * fields of the generated OpenAPI document.
 *
 * The decorators only affect Swagger document generation. They do not change
 * runtime behavior, validation, or SDK function signatures.
 *
 * Example:
 *
 * ```typescript
 * import core from "@nestia/core";
 * import { Controller } from "@nestjs/common";
 * import typia from "typia";
 *
 * @Controller("bbs/articles

... (truncated -- full source via MCP)

See the full source, get the GitHub permalink, and search for more like it.

Get a free API key