npx nestia swagger
npx nestia swagger --config nestia.config.ts --project tsconfig.json

import { INestiaConfig } from "@nestia/sdk";
import { NestFactory } from "@nestjs/core";
 
import { YourModule } from "./src/YourModule";
 
const NESTIA_CONFIG: INestiaConfig = {
    input: async () => {
        const app = await NestFactory.create(YourModule);
        // app.setGlobalPrefix("api");
        // app.enableVersioning({
        //     type: VersioningType.URI,
        //     prefix: "v", 
        // })
        return app;
    },
    swagger: {
        output: "dist/swagger.json",
        beautify: true,
        security: {
            bearer: {
                type: "apiKey",
                name: "Authorization",
                in: "header",
            },
        },
        servers: [
            {
                url: "http://localhost:3000",
                description: "Local Server"
            }
        ],
    }
};
export default NESTIA_CONFIG;

import { INestiaConfig } from "@nestia/sdk";
 
const NESTIA_CONFIG: INestiaConfig = {
    input: [
        "src/controllers", 
        "src/fake/controllers", 
        "src/test/controllers",
    ],
    swagger: {
        output: "dist/swagger.json",
        beautify: true,
        security: {
            bearer: {
                type: "apiKey",
                name: "Authorization",
                in: "header",
            },
        },
        servers: [
            {
                url: "http://localhost:3000",
                description: "Local Server"
            }
        ],
    }
};
export default NESTIA_CONFIG;

import { TypedBody, TypedParam, TypedRoute } from "@nestia/core";
import { Controller } from "@nestjs/common";
import { ApiSecurity } from "@nestjs/swagger";
import typia, { tags } from "typia";
 
import { IBbsArticle } from "@api/lib/structures/IBbsArticle";
 
@Controller("bbs/articles/:section")
export class BbsArticlesController {
    /**
     * Would be shown without any mark.
     *
     * @param section Section code
     * @param input Content to store
     * @returns Newly archived article
     * 
     * @tag public
     * @summary Public API
     * @security bearer
     * @security oauth2 read write
     */
    @TypedRoute.Post()
    public async store(
        @TypedParam("section") section: string,
        @TypedBody() input: IBbsArticle.IStore,
    ): Promise<IBbsArticle> {
        return {
            ...typia.random<IBbsArticle>(),
            ...input,
            section,
        };
    }
 
    /**
     * Deprecated API.
     *
     * Would be marked as "deprecated".
     *
     * For reference, top sentence "Deprecated API." can replace the `@summary` tag.
     *
     * @param section Section code
     * @param id Target article ID
     * @param input Content to update
     * @returns Updated content
     *
     * @deprecated
     * @operationId updateArticle
     * @security basic
     * @security bearer
     */
    @TypedRoute.Put(":id")
    public async update(
        @TypedParam("section") section: string,
        @TypedParam("id") id: string & tags.Format<"uuid">,
        @TypedBody() input: IBbsArticle.IStore,
    ): Promise<IBbsArticle> {
        return {
            ...typia.random<IBbsArticle>(),
            ...input,
            id,
            section,
        };
    }
 
    /**
     * Would not be shown.
     *
     * @internal
     */
    @ApiSecurity("custom") // LEGACY DECRATOR ALSO CAN BE USED
    @TypedRoute.Delete(":id")
    public erase(
        @TypedParam("section") section: string,
        @TypedParam("id") id: string & tags.Format<"uuid">,
    ): void {
        section;
        id;
    }
}

export interface SpecialTag {
    /**
     * Deprecated tags are just used for marking.
     * 
     * @title Unsigned integer
     * @deprecated
     */
    type: number & tags.Type<"uint32">;
 
    /**
     * Internal tagged property never be shown in JSON schema.
     * 
     * It even doesn't be shown in other `typia` functions like `assert<T>()`.
     * 
     * @internal
     */
    internal: number[];
 
    /**
     * Hidden tagged property never be shown in JSON schema.
     * 
     * However, it would be shown in other `typia` functions like `stringify<T>()`.
     * 
     * @hidden
     */
    hidden: boolean;
 
    /**
     * You can limit the range of number.
     *
     * Also, you can configure `default` property by comment tag.
     * 
     * @default 30
     */
    number?: number & tags.ExclusiveMinimum<19> & tags.Maximum<100>;
 
    /**
     * You can limit the length of string.
     */
    string: string & tags.MinLength<3>;
 
    /**
     * You can limit the pattern of string.
     */
    pattern: string & tags.Pattern<"^[a-z]+$">;
 
    /**
     * You can limit the format of string.
     */
    format: null | (string & tags.Format<"date-time">);
 
    /**
     * You also can perform union type in type tags.
     */
    ip: string & (tags.Format<"ipv4"> | tags.Format<"ipv6">);
    
    /**
     * In the Array case, only type tags can limit elements' type.
     */
    array: Array<string & tags.Format<"uuid">>
        & tags.MinItems<3>
        & tags.MaxItems<100>;
}