Close #1054: add support for ApiExtension decorator

packages/sdk/src/analyses/ReflectHttpOperationAnalyzer.ts

@@ -116,6 +116,7 @@ export namespace ReflectHttpOperationAnalyzer {
         .find(({ name }) => name === "operationId")
         ?.text?.[0].text.split(" ")[0]
         .trim(),
+      extensions: ReflectMetadataAnalyzer.extensions(props.function),
     };
 
     // VALIDATE PATH ARGUMENTS

packages/sdk/src/analyses/ReflectMetadataAnalyzer.ts

@@ -12,6 +12,14 @@ export namespace ReflectMetadataAnalyzer {
     else return value;
   };
 
+  export const extensions = (value: any): Record<string, any> => {
+    const entire: Record<string, any>[] | undefined = Reflect.getMetadata(
+      "swagger/apiExtension",
+      value,
+    );
+    return entire ?? {};
+  };
+
   export const securities = (value: any): Record<string, string[]>[] => {
     const entire: Record<string, string[]>[] | undefined = Reflect.getMetadata(
       "swagger/apiSecurity",

packages/sdk/src/analyses/TypedHttpRouteAnalyzer.ts

@@ -163,6 +163,7 @@ export namespace TypedHttpRouteAnalyzer {
       exceptions,
       parameters,
       success,
+      extensions: props.operation.extensions,
     }));
   };
 }

packages/sdk/src/generates/internal/SwaggerOperationComposer.ts

@@ -111,6 +111,7 @@ export namespace SwaggerOperationComposer {
         route: props.route,
       }),
       security: security.length ? security : undefined,
+      ...(props.route.extensions ?? {}),
     };
   };
 }

packages/sdk/src/structures/IReflectHttpOperation.ts

@@ -22,4 +22,5 @@ export interface IReflectHttpOperation {
   operationId: string | undefined;
   description: string | null;
   jsDocTags: IJsDocTagInfo[];
+  extensions?: Record<string, any>;
 }

packages/sdk/src/structures/ITypedHttpRoute.ts

@@ -26,4 +26,5 @@ export interface ITypedHttpRoute {
   description: string | null;
   jsDocTags: IJsDocTagInfo[];
   operationId: string | undefined;
+  extensions?: Record<string, any>;
 }

test/features/swagger-extensions/nestia.config.ts

@@ -0,0 +1,25 @@
+import { INestiaConfig } from "@nestia/sdk";
+
+export const NESTIA_CONFIG: INestiaConfig = {
+  input: ["src/controllers"],
+  output: "src/api",
+  e2e: "src/test",
+  swagger: {
+    output: "swagger.json",
+    info: {
+      title: "Nestia Swagger Generation Test",
+    },
+    servers: [
+      {
+        url: "http://localhost:3000",
+        description: "Local Server",
+      },
+    ],
+    security: {
+      bearer: {
+        type: "apiKey",
+      },
+    },
+  },
+};
+export default NESTIA_CONFIG;

test/features/swagger-extensions/package.json

@@ -0,0 +1,4 @@
+{
+    "name": "@nestia/test-swagger",
+    "version": "1.0.3"
+}

test/features/swagger-extensions/src/api/HttpError.ts

@@ -0,0 +1 @@
+export { HttpError } from "@nestia/fetcher";

test/features/swagger-extensions/src/api/IConnection.ts

@@ -0,0 +1 @@
+export type { IConnection } from "@nestia/fetcher";

test/features/swagger-extensions/src/api/Primitive.ts

@@ -0,0 +1 @@
+export type { Primitive } from "@nestia/fetcher";

test/features/swagger-extensions/src/api/Resolved.ts

@@ -0,0 +1 @@
+export type { Resolved } from "@nestia/fetcher";

test/features/swagger-extensions/src/api/functional/health/index.ts

@@ -0,0 +1,35 @@
+/**
+ * @packageDocumentation
+ * @module api.functional.health
+ * @nestia Generated by Nestia - https://github.com/samchon/nestia
+ */
+//================================================================
+import type { IConnection } from "@nestia/fetcher";
+import { PlainFetcher } from "@nestia/fetcher/lib/PlainFetcher";
+
+/**
+ * @controller HealthController.get
+ * @path GET /health
+ * @nestia Generated by Nestia - https://github.com/samchon/nestia
+ */
+export async function get(connection: IConnection): Promise<void> {
+  return PlainFetcher.fetch(connection, {
+    ...get.METADATA,
+    template: get.METADATA.path,
+    path: get.path(),
+  });
+}
+export namespace get {
+  export const METADATA = {
+    method: "GET",
+    path: "/health",
+    request: null,
+    response: {
+      type: "application/json",
+      encrypted: false,
+    },
+    status: 200,
+  } as const;
+
+  export const path = () => "/health";
+}

test/features/swagger-extensions/src/api/functional/index.ts

@@ -0,0 +1,8 @@
+/**
+ * @packageDocumentation
+ * @module api.functional
+ * @nestia Generated by Nestia - https://github.com/samchon/nestia
+ */
+//================================================================
+export * as health from "./health";
+export * as performance from "./performance";

test/features/swagger-extensions/src/api/functional/performance/index.ts

@@ -0,0 +1,39 @@
+/**
+ * @packageDocumentation
+ * @module api.functional.performance
+ * @nestia Generated by Nestia - https://github.com/samchon/nestia
+ */
+//================================================================
+import type { IConnection, Primitive } from "@nestia/fetcher";
+import { PlainFetcher } from "@nestia/fetcher/lib/PlainFetcher";
+
+import type { IPerformance } from "../../structures/IPerformance";
+
+/**
+ * @controller PerformanceController.get
+ * @path GET /performance
+ * @nestia Generated by Nestia - https://github.com/samchon/nestia
+ */
+export async function get(connection: IConnection): Promise<get.Output> {
+  return PlainFetcher.fetch(connection, {
+    ...get.METADATA,
+    template: get.METADATA.path,
+    path: get.path(),
+  });
+}
+export namespace get {
+  export type Output = Primitive<IPerformance>;
+
+  export const METADATA = {
+    method: "GET",
+    path: "/performance",
+    request: null,
+    response: {
+      type: "application/json",
+      encrypted: false,
+    },
+    status: 200,
+  } as const;
+
+  export const path = () => "/performance";
+}

test/features/swagger-extensions/src/api/index.ts

@@ -0,0 +1,4 @@
+import * as api from "./module";
+
+export * from "./module";
+export default api;

test/features/swagger-extensions/src/api/module.ts

@@ -0,0 +1,6 @@
+export type * from "./IConnection";
+export type * from "./Primitive";
+export type * from "./Resolved";
+export * from "./HttpError";
+
+export * as functional from "./functional";

test/features/swagger-extensions/src/api/structures/IPerformance.ts

@@ -0,0 +1,10 @@
+/**
+ * Performance info.
+ *
+ * @author Samchon
+ */
+export interface IPerformance {
+  cpu: NodeJS.CpuUsage;
+  memory: NodeJS.MemoryUsage;
+  resource: NodeJS.ResourceUsage;
+}

test/features/swagger-extensions/src/api/structures/ISystem.ts

@@ -0,0 +1,81 @@
+/**
+ * System Information.
+ *
+ * @author Jeongho Nam
+ */
+export interface ISystem {
+  /**
+   * Random Unique ID.
+   */
+  uid: number;
+
+  /**
+   * `process.argv`
+   */
+  arguments: string[];
+
+  /**
+   * Git commit info.
+   */
+  commit: ISystem.ICommit;
+
+  /**
+   * `package.json`
+   */
+  package: ISystem.IPackage;
+
+  /**
+   * Creation time of this server.
+   */
+  created_at: string;
+}
+
+export namespace ISystem {
+  /**
+   * Git commit info.
+   */
+  export interface ICommit {
+    shortHash: string;
+    branch: string;
+    hash: string;
+    subject: string;
+    sanitizedSubject: string;
+    body: string;
+    author: ICommit.IUser;
+    committer: ICommit.IUser;
+    authored_at: string;
+    commited_at: string;
+    notes?: string;
+    tags: string[];
+  }
+  export namespace ICommit {
+    /**
+     * Git user account info.
+     */
+    export interface IUser {
+      name: string;
+      email: string;
+    }
+  }
+
+  /**
+   * NPM package info.
+   */
+  export interface IPackage {
+    name: string;
+    version: string;
+    description: string;
+    main?: string;
+    typings?: string;
+    scripts: Record<string, string>;
+    repository: { type: "git"; url: string };
+    author: string;
+    license: string;
+    bugs: { url: string };
+    homepage: string;
+    devDependencies?: Record<string, string>;
+    dependencies: Record<string, string>;
+    publishConfig?: { registry: string };
+    files?: string[];
+  }
+}

test/features/swagger-extensions/src/controllers/HealthController.ts

@@ -0,0 +1,8 @@
+import core from "@nestia/core";
+import { Controller } from "@nestjs/common";
+
+@Controller("health")
+export class HealthController {
+  @core.TypedRoute.Get()
+  public get(): void {}
+}

test/features/swagger-extensions/src/controllers/PerformanceController.ts

@@ -0,0 +1,19 @@
+import core from "@nestia/core";
+import { Controller } from "@nestjs/common";
+import { ApiExtension } from "@nestjs/swagger";
+
+import { IPerformance } from "@api/lib/structures/IPerformance";
+
+@Controller("performance")
+export class PerformanceController {
+  @ApiExtension("x-visibility", "public")
+  @ApiExtension("x-deprecated", true)
+  @core.TypedRoute.Get()
+  public async get(): Promise<IPerformance> {
+    return {
+      cpu: process.cpuUsage(),
+      memory: process.memoryUsage(),
+      resource: process.resourceUsage(),
+    };
+  }
+}

test/features/swagger-extensions/src/test/features/api/automated/test_api_health_get.ts

@@ -0,0 +1,8 @@
+import typia from "typia";
+
+import api from "../../../../api";
+
+export const test_api_health_get = async (connection: api.IConnection) => {
+  const output = await api.functional.health.get(connection);
+  typia.assert(output);
+};

test/features/swagger-extensions/src/test/features/api/automated/test_api_performance_get.ts

@@ -0,0 +1,11 @@
+import type { Primitive } from "@nestia/fetcher";
+import typia from "typia";
+
+import api from "../../../../api";
+import type { IPerformance } from "../../../../api/structures/IPerformance";
+
+export const test_api_performance_get = async (connection: api.IConnection) => {
+  const output: Primitive<IPerformance> =
+    await api.functional.performance.get(connection);
+  typia.assert(output);
+};

test/features/swagger-extensions/src/test/features/swagger/test_swagger.ts

@@ -0,0 +1,20 @@
+import { TestValidator } from "@nestia/e2e";
+
+export async function test_swagger(): Promise<void> {
+  const { NESTIA_CONFIG } = await import(
+    __dirname + "/../../../../nestia.config.ts"
+  );
+  const pack = await import(__dirname + "/../../../../package.json");
+  const swagger = await import(__dirname + "/../../../../swagger.json");
+
+  TestValidator.equals("info.version")(pack.version)(swagger.info.version);
+  TestValidator.equals("info.title")(NESTIA_CONFIG.swagger.info.title)(
+    swagger.info.title,
+  );
+  TestValidator.equals("info.description")(
+    "Generated by nestia - https://github.com/samchon/nestia",
+  );
+  TestValidator.equals("servers")(NESTIA_CONFIG.swagger.servers)(
+    swagger.servers,
+  );
+}