Documentation
    Preparing search index...

    Namespace SwaggerExample

    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.

    import core from "@nestia/core";
    import { Controller } from "@nestjs/common";
    import typia from "typia";

    @Controller("bbs/articles")
    export class BbsArticlesController {
      // Single response example.
      @core.SwaggerExample.Response(typia.random<IBbsArticle>())
      @core.TypedRoute.Post()
      public async create(
        // Multiple named parameter examples plus a default one.
        @core.SwaggerExample.Parameter(typia.random<IBbsArticle.ICreate>())
        @core.SwaggerExample.Parameter("x", typia.random<IBbsArticle.ICreate>())
        @core.SwaggerExample.Parameter("y", typia.random<IBbsArticle.ICreate>())
        @core.TypedBody()
        input: IBbsArticle.ICreate,
      ): Promise<IBbsArticle> {
        // ...
      }
    }

    Jeongho Nam - https://github.com/samchon

    Interfaces

    IData

    Functions

    Parameter
    Response

    Settings

    Member Visibility

    On This Page

    Interfaces
    Functions