From c74757d692f9e02dcb568c7ece3393f74be9ec8e Mon Sep 17 00:00:00 2001
From: liuyi <liuyiinhhu@gmail.com>
Date: Thu, 12 Jun 2025 23:45:42 +0800
Subject: [PATCH] add route module

---
 src/modules/restful/types.ts | 34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)
 create mode 100644 src/modules/restful/types.ts

diff --git a/src/modules/restful/types.ts b/src/modules/restful/types.ts
new file mode 100644
index 0000000..3ed5aa1
--- /dev/null
+++ b/src/modules/restful/types.ts
@@ -0,0 +1,34 @@
+import { Type } from '@nestjs/common';
+import { ExternalDocumentationObject } from '@nestjs/swagger/dist/interfaces/open-api-spec.interface';
+
+export interface TagOption {
+    name: string;
+    description?: string;
+    externalDocs?: ExternalDocumentationObject;
+}
+
+export interface ApiDocSource {
+    title?: string;
+    description?: string;
+    auth?: boolean;
+    tags?: (string | TagOption)[];
+}
+
+export interface ApiConfig extends ApiDocSource {
+    docuri?: string;
+    default: string;
+    enable: string;
+    versions: Record<string, VersionOption>;
+}
+
+export interface VersionOption extends ApiDocSource {
+    routes?: RouteOption[];
+}
+
+export interface RouteOption {
+    name: string;
+    path: string;
+    controllers: Type<any>[];
+    children?: RouteOption[];
+    doc?: ApiDocSource;
+}