feat: custom swagger decorators

package-lock.json

@@ -25,11 +25,12 @@
         "mongoose": "^8.0.3",
         "npm": "^10.2.5",
         "path": "^0.12.7",
-        "tsc-alias": "^1.8.8",
-        "tspec": "^0.1.112"
+        "swagger-ui-express": "^5.0.0",
+        "tsc-alias": "^1.8.8"
       },
       "devDependencies": {
         "@types/express": "^4.17.21",
+        "@types/swagger-ui-express": "^4.1.6",
         "nodemon": "^3.0.2",
         "ts-node": "^10.9.2",
         "ts-node-dev": "^2.0.0",
@@ -37,15 +38,11 @@
         "typescript": "^5.3.3"
       }
     },
-    "node_modules/@cloudflare/json-schema-walker": {
-      "version": "0.1.1",
-      "resolved": "https://registry.npmjs.org/@cloudflare/json-schema-walker/-/json-schema-walker-0.1.1.tgz",
-      "integrity": "sha512-P3n0hEgk1m6uKWgL4Yb1owzXVG4pM70G4kRnDQxZXiVvfCRtaqiHu+ZRiRPzmwGBiLTO1LWc2yR1M8oz0YkXww=="
-    },
     "node_modules/@cspotcode/source-map-support": {
       "version": "0.8.1",
       "resolved": "https://registry.npmjs.org/@cspotcode/source-map-support/-/source-map-support-0.8.1.tgz",
       "integrity": "sha512-IchNf6dN4tHoMFIn/7OE8LWZ19Y6q/67Bmf6vnGREv8RSbBVb9LPJxEcnwrcwX6ixSvaiGoomAUvu4YSxXrVgw==",
+      "dev": true,
       "dependencies": {
         "@jridgewell/trace-mapping": "0.3.9"
       },
@@ -165,6 +162,7 @@
       "version": "3.1.1",
       "resolved": "https://registry.npmjs.org/@jridgewell/resolve-uri/-/resolve-uri-3.1.1.tgz",
       "integrity": "sha512-dSYZh7HhCDtCKm4QakX0xFpsRDqjjtZf/kjI/v3T3Nwt5r8/qz/M19F9ySyOqU94SXBmeG9ttTul+YnR4LOxFA==",
+      "dev": true,
       "engines": {
         "node": ">=6.0.0"
       }
@@ -172,12 +170,14 @@
     "node_modules/@jridgewell/sourcemap-codec": {
       "version": "1.4.15",
       "resolved": "https://registry.npmjs.org/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.4.15.tgz",
-      "integrity": "sha512-eF2rxCRulEKXHTRiDrDy6erMYWqNw4LPdQ8UQA4huuxaQsVeRPFl2oM8oDGxMFhJUWZf9McpLtJasDDZb/Bpeg=="
+      "integrity": "sha512-eF2rxCRulEKXHTRiDrDy6erMYWqNw4LPdQ8UQA4huuxaQsVeRPFl2oM8oDGxMFhJUWZf9McpLtJasDDZb/Bpeg==",
+      "dev": true
     },
     "node_modules/@jridgewell/trace-mapping": {
       "version": "0.3.9",
       "resolved": "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.3.9.tgz",
       "integrity": "sha512-3Belt6tdc8bPgAtbcmdtNJlirVoTmEb5e2gC94PnkwEW9jI6CAHUeoG85tjWP5WquqfavoMtMwiG4P926ZKKuQ==",
+      "dev": true,
       "dependencies": {
         "@jridgewell/resolve-uri": "^3.0.3",
         "@jridgewell/sourcemap-codec": "^1.4.10"
@@ -286,28 +286,32 @@
     "node_modules/@tsconfig/node10": {
       "version": "1.0.9",
       "resolved": "https://registry.npmjs.org/@tsconfig/node10/-/node10-1.0.9.tgz",
-      "integrity": "sha512-jNsYVVxU8v5g43Erja32laIDHXeoNvFEpX33OK4d6hljo3jDhCBDhx5dhCCTMWUojscpAagGiRkBKxpdl9fxqA=="
+      "integrity": "sha512-jNsYVVxU8v5g43Erja32laIDHXeoNvFEpX33OK4d6hljo3jDhCBDhx5dhCCTMWUojscpAagGiRkBKxpdl9fxqA==",
+      "dev": true
     },
     "node_modules/@tsconfig/node12": {
       "version": "1.0.11",
       "resolved": "https://registry.npmjs.org/@tsconfig/node12/-/node12-1.0.11.tgz",
-      "integrity": "sha512-cqefuRsh12pWyGsIoBKJA9luFu3mRxCA+ORZvA4ktLSzIuCUtWVxGIuXigEwO5/ywWFMZ2QEGKWvkZG1zDMTag=="
+      "integrity": "sha512-cqefuRsh12pWyGsIoBKJA9luFu3mRxCA+ORZvA4ktLSzIuCUtWVxGIuXigEwO5/ywWFMZ2QEGKWvkZG1zDMTag==",
+      "dev": true
     },
     "node_modules/@tsconfig/node14": {
       "version": "1.0.3",
       "resolved": "https://registry.npmjs.org/@tsconfig/node14/-/node14-1.0.3.tgz",
-      "integrity": "sha512-ysT8mhdixWK6Hw3i1V2AeRqZ5WfXg1G43mqoYlM2nc6388Fq5jcXyr5mRsqViLx/GJYdoL0bfXD8nmF+Zn/Iow=="
+      "integrity": "sha512-ysT8mhdixWK6Hw3i1V2AeRqZ5WfXg1G43mqoYlM2nc6388Fq5jcXyr5mRsqViLx/GJYdoL0bfXD8nmF+Zn/Iow==",
+      "dev": true
     },
     "node_modules/@tsconfig/node16": {
       "version": "1.0.4",
       "resolved": "https://registry.npmjs.org/@tsconfig/node16/-/node16-1.0.4.tgz",
-      "integrity": "sha512-vxhUy4J8lyeyinH7Azl1pdd43GJhZH/tP2weN8TntQblOY+A0XbT8DJk1/oCPuOOyg/Ja757rG0CgHcWC8OfMA=="
+      "integrity": "sha512-vxhUy4J8lyeyinH7Azl1pdd43GJhZH/tP2weN8TntQblOY+A0XbT8DJk1/oCPuOOyg/Ja757rG0CgHcWC8OfMA==",
+      "dev": true
     },
     "node_modules/@types/body-parser": {
       "version": "1.19.5",
       "resolved": "https://registry.npmjs.org/@types/body-parser/-/body-parser-1.19.5.tgz",
       "integrity": "sha512-fB3Zu92ucau0iQ0JMCFQE7b/dv8Ot07NI3KaZIkIUNXq82k4eBAqUaneXfleGY9JWskeS9y+u0nXMyspcuQrCg==",
-      "devOptional": true,
+      "dev": true,
       "dependencies": {
         "@types/connect": "*",
         "@types/node": "*"
@@ -317,7 +321,7 @@
       "version": "3.4.38",
       "resolved": "https://registry.npmjs.org/@types/connect/-/connect-3.4.38.tgz",
       "integrity": "sha512-K6uROf1LD88uDQqJCktA4yzL1YYAK6NgfsI0v/mTgyPKWsX1CnJ0XPSDhViejru1GcRkLWb8RlzFYJRqGUbaug==",
-      "devOptional": true,
+      "dev": true,
       "dependencies": {
         "@types/node": "*"
       }
@@ -326,7 +330,7 @@
       "version": "4.17.21",
       "resolved": "https://registry.npmjs.org/@types/express/-/express-4.17.21.tgz",
       "integrity": "sha512-ejlPM315qwLpaQlQDTjPdsUFSc6ZsP4AN6AlWnogPjQ7CVi7PYF3YVz+CY3jE2pwYf7E/7HlDAN0rV2GxTG0HQ==",
-      "devOptional": true,
+      "dev": true,
       "dependencies": {
         "@types/body-parser": "*",
         "@types/express-serve-static-core": "^4.17.33",
@@ -338,7 +342,7 @@
       "version": "4.17.41",
       "resolved": "https://registry.npmjs.org/@types/express-serve-static-core/-/express-serve-static-core-4.17.41.tgz",
       "integrity": "sha512-OaJ7XLaelTgrvlZD8/aa0vvvxZdUmlCn6MtWeB7TkiKW70BQLc9XEPpDLPdbo52ZhXUCrznlWdCHWxJWtdyajA==",
-      "devOptional": true,
+      "dev": true,
       "dependencies": {
         "@types/node": "*",
         "@types/qs": "*",
@@ -359,26 +363,13 @@
       "version": "2.0.4",
       "resolved": "https://registry.npmjs.org/@types/http-errors/-/http-errors-2.0.4.tgz",
       "integrity": "sha512-D0CFMMtydbJAegzOyHjtiKPLlvnm3iTZyZRSZoLq2mRhDdmLfIWOCYPfQJ4cu2erKghU++QvjcUjp/5h7hESpA==",
-      "devOptional": true
-    },
-    "node_modules/@types/http-proxy": {
-      "version": "1.17.14",
-      "resolved": "https://registry.npmjs.org/@types/http-proxy/-/http-proxy-1.17.14.tgz",
-      "integrity": "sha512-SSrD0c1OQzlFX7pGu1eXxSEjemej64aaNPRhhVYUGqXh0BtldAAx37MG8btcumvpgKyZp1F5Gn3JkktdxiFv6w==",
-      "dependencies": {
-        "@types/node": "*"
-      }
-    },
-    "node_modules/@types/json-schema": {
-      "version": "7.0.15",
-      "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.15.tgz",
-      "integrity": "sha512-5+fP8P8MFNC+AyZCDxrB2pkZFPGzqQWUzpSeuuVLvm8VMcorNYavBqoFcxK8bQz4Qsbn4oUEEem4wDLfcysGHA=="
+      "dev": true
     },
     "node_modules/@types/mime": {
       "version": "1.3.5",
       "resolved": "https://registry.npmjs.org/@types/mime/-/mime-1.3.5.tgz",
       "integrity": "sha512-/pyBZWSLD2n0dcHE3hq8s8ZvcETHtEuF+3E7XVt0Ig2nvsVQXdghHVcEkIWjy9A0wKfTn97a/PSDYohKIlnP/w==",
-      "devOptional": true
+      "dev": true
     },
     "node_modules/@types/minimatch": {
       "version": "5.1.2",
@@ -397,19 +388,19 @@
       "version": "6.9.11",
       "resolved": "https://registry.npmjs.org/@types/qs/-/qs-6.9.11.tgz",
       "integrity": "sha512-oGk0gmhnEJK4Yyk+oI7EfXsLayXatCWPHary1MtcmbAifkobT9cM9yutG/hZKIseOU0MqbIwQ/u2nn/Gb+ltuQ==",
-      "devOptional": true
+      "dev": true
     },
     "node_modules/@types/range-parser": {
       "version": "1.2.7",
       "resolved": "https://registry.npmjs.org/@types/range-parser/-/range-parser-1.2.7.tgz",
       "integrity": "sha512-hKormJbkJqzQGhziax5PItDUTMAM9uE2XXQmM37dyd4hVM+5aVl7oVxMVUiVQn2oCQFN/LKCZdvSM0pFRqbSmQ==",
-      "devOptional": true
+      "dev": true
     },
     "node_modules/@types/send": {
       "version": "0.17.4",
       "resolved": "https://registry.npmjs.org/@types/send/-/send-0.17.4.tgz",
       "integrity": "sha512-x2EM6TJOybec7c52BX0ZspPodMsQUd5L6PRwOunVyVUhXiBSKf3AezDL8Dgvgt5o0UfKNfuA0eMLr2wLT4AiBA==",
-      "devOptional": true,
+      "dev": true,
       "dependencies": {
         "@types/mime": "^1",
         "@types/node": "*"
@@ -419,7 +410,7 @@
       "version": "1.15.5",
       "resolved": "https://registry.npmjs.org/@types/serve-static/-/serve-static-1.15.5.tgz",
       "integrity": "sha512-PDRk21MnK70hja/YF8AHfC7yIsiQHn1rcXx7ijCFBX/k+XQJhQT/gw3xekXKJvx+5SXaMMS8oqQy09Mzvz2TuQ==",
-      "devOptional": true,
+      "dev": true,
       "dependencies": {
         "@types/http-errors": "*",
         "@types/mime": "*",
@@ -438,6 +429,16 @@
       "integrity": "sha512-7NQmHra/JILCd1QqpSzl8+mJRc8ZHz3uDm8YV1Ks9IhK0epEiTw8aIErbvH9PI+6XbqhyIQy3462nEsn7UVzjQ==",
       "dev": true
     },
+    "node_modules/@types/swagger-ui-express": {
+      "version": "4.1.6",
+      "resolved": "https://registry.npmjs.org/@types/swagger-ui-express/-/swagger-ui-express-4.1.6.tgz",
+      "integrity": "sha512-UVSiGYXa5IzdJJG3hrc86e8KdZWLYxyEsVoUI4iPXc7CO4VZ3AfNP8d/8+hrDRIqz+HAaSMtZSqAsF3Nq2X/Dg==",
+      "dev": true,
+      "dependencies": {
+        "@types/express": "*",
+        "@types/serve-static": "*"
+      }
+    },
     "node_modules/@types/webidl-conversions": {
       "version": "7.0.3",
       "resolved": "https://registry.npmjs.org/@types/webidl-conversions/-/webidl-conversions-7.0.3.tgz",
@@ -473,6 +474,7 @@
       "version": "8.11.2",
       "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.11.2.tgz",
       "integrity": "sha512-nc0Axzp/0FILLEVsm4fNwLCwMttvhEI263QtVPQcbpfZZ3ts0hLsZGOpE6czNlid7CJ9MlyH8reXkpsf3YUY4w==",
+      "dev": true,
       "bin": {
         "acorn": "bin/acorn"
       },
@@ -484,6 +486,7 @@
       "version": "8.3.1",
       "resolved": "https://registry.npmjs.org/acorn-walk/-/acorn-walk-8.3.1.tgz",
       "integrity": "sha512-TgUZgYvqZprrl7YldZNoa9OciCAyZR+Ejm9eXzKCmjsF5IKp/wgQ7Z/ZpjpGTIUPwrHQIcYeI8qDh4PsEwxMbw==",
+      "dev": true,
       "engines": {
         "node": ">=0.4.0"
       }
@@ -550,7 +553,8 @@
     "node_modules/arg": {
       "version": "4.1.3",
       "resolved": "https://registry.npmjs.org/arg/-/arg-4.1.3.tgz",
-      "integrity": "sha512-58S9QDqG0Xx27YwPSt9fJxivjYl432YCwfDMfZ+71RAqUrZef7LrKQZ3LHLOwCS4FLNBplP533Zx895SeOCHvA=="
+      "integrity": "sha512-58S9QDqG0Xx27YwPSt9fJxivjYl432YCwfDMfZ+71RAqUrZef7LrKQZ3LHLOwCS4FLNBplP533Zx895SeOCHvA==",
+      "dev": true
     },
     "node_modules/array-flatten": {
       "version": "1.1.1",
@@ -690,49 +694,6 @@
       "resolved": "https://registry.npmjs.org/class-transformer/-/class-transformer-0.5.1.tgz",
       "integrity": "sha512-SQa1Ws6hUbfC98vKGxZH3KFY0Y1lm5Zm0SY8XX9zbK7FJCyVEac3ATW0RIpwzW+oOfmHE5PMPufDG9hCfoEOMw=="
     },
-    "node_modules/cliui": {
-      "version": "8.0.1",
-      "resolved": "https://registry.npmjs.org/cliui/-/cliui-8.0.1.tgz",
-      "integrity": "sha512-BSeNnyus75C4//NQ9gQt1/csTXyo/8Sb+afLAkzAptFuMsod9HFokGNudZpi/oQV73hnVK+sR+5PVRMd+Dr7YQ==",
-      "dependencies": {
-        "string-width": "^4.2.0",
-        "strip-ansi": "^6.0.1",
-        "wrap-ansi": "^7.0.0"
-      },
-      "engines": {
-        "node": ">=12"
-      }
-    },
-    "node_modules/cliui/node_modules/ansi-styles": {
-      "version": "4.3.0",
-      "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz",
-      "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==",
-      "dependencies": {
-        "color-convert": "^2.0.1"
-      },
-      "engines": {
-        "node": ">=8"
-      },
-      "funding": {
-        "url": "https://github.com/chalk/ansi-styles?sponsor=1"
-      }
-    },
-    "node_modules/cliui/node_modules/wrap-ansi": {
-      "version": "7.0.0",
-      "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz",
-      "integrity": "sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==",
-      "dependencies": {
-        "ansi-styles": "^4.0.0",
-        "string-width": "^4.1.0",
-        "strip-ansi": "^6.0.0"
-      },
-      "engines": {
-        "node": ">=10"
-      },
-      "funding": {
-        "url": "https://github.com/chalk/wrap-ansi?sponsor=1"
-      }
-    },
     "node_modules/color-convert": {
       "version": "2.0.1",
       "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz",
@@ -822,7 +783,8 @@
     "node_modules/create-require": {
       "version": "1.1.1",
       "resolved": "https://registry.npmjs.org/create-require/-/create-require-1.1.1.tgz",
-      "integrity": "sha512-dcKFX3jn0MpIaXjisoRvexIJVEKzaq7z2rZKxf+MSr9TkdmHmsU4m2lcLojrj/FHl8mk5VxMmYA+ftRkP/3oKQ=="
+      "integrity": "sha512-dcKFX3jn0MpIaXjisoRvexIJVEKzaq7z2rZKxf+MSr9TkdmHmsU4m2lcLojrj/FHl8mk5VxMmYA+ftRkP/3oKQ==",
+      "dev": true
     },
     "node_modules/cross-spawn": {
       "version": "7.0.3",
@@ -900,6 +862,7 @@
       "version": "4.0.2",
       "resolved": "https://registry.npmjs.org/diff/-/diff-4.0.2.tgz",
       "integrity": "sha512-58lmxKSA4BNyLz+HHMUzlOEpg09FV+ev6ZMe3vJihgdxzgcwZ8VoEEPmALCZG9LmqfVoNMMKpttIYTVG6uDY7A==",
+      "dev": true,
       "engines": {
         "node": ">=0.3.1"
       }
@@ -966,14 +929,6 @@
         "node": ">= 0.8"
       }
     },
-    "node_modules/escalade": {
-      "version": "3.1.2",
-      "resolved": "https://registry.npmjs.org/escalade/-/escalade-3.1.2.tgz",
-      "integrity": "sha512-ErCHMCae19vR8vQGe50xIsVomy19rg6gFu3+r3jkEO46suLMWBksvVyoGgQV+jOfl84ZSOSlmv6Gxa89PmTGmA==",
-      "engines": {
-        "node": ">=6"
-      }
-    },
     "node_modules/escape-html": {
       "version": "1.0.3",
       "resolved": "https://registry.npmjs.org/escape-html/-/escape-html-1.0.3.tgz",
@@ -987,11 +942,6 @@
         "node": ">= 0.6"
       }
     },
-    "node_modules/eventemitter3": {
-      "version": "4.0.7",
-      "resolved": "https://registry.npmjs.org/eventemitter3/-/eventemitter3-4.0.7.tgz",
-      "integrity": "sha512-8guHBZCwKnFhYdHr2ysuRWErTwhoN2X8XELRlrRwpmfeY2jjuUN4taQMsULKUVo1K4DvZl+0pgfyoysHxvmvEw=="
-    },
     "node_modules/express": {
       "version": "4.18.2",
       "resolved": "https://registry.npmjs.org/express/-/express-4.18.2.tgz",
@@ -1158,25 +1108,6 @@
       "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz",
       "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A=="
     },
-    "node_modules/follow-redirects": {
-      "version": "1.15.6",
-      "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.6.tgz",
-      "integrity": "sha512-wWN62YITEaOpSK584EZXJafH1AGpO8RVgElfkuXbTOrPX4fIfOyEpW/CsiNd8JdYrAoOvafRTOEnvsO++qCqFA==",
-      "funding": [
-        {
-          "type": "individual",
-          "url": "https://github.com/sponsors/RubenVerborgh"
-        }
-      ],
-      "engines": {
-        "node": ">=4.0"
-      },
-      "peerDependenciesMeta": {
-        "debug": {
-          "optional": true
-        }
-      }
-    },
     "node_modules/foreground-child": {
       "version": "3.1.1",
       "resolved": "https://registry.npmjs.org/foreground-child/-/foreground-child-3.1.1.tgz",
@@ -1286,14 +1217,6 @@
         "node": ">=10"
       }
     },
-    "node_modules/get-caller-file": {
-      "version": "2.0.5",
-      "resolved": "https://registry.npmjs.org/get-caller-file/-/get-caller-file-2.0.5.tgz",
-      "integrity": "sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg==",
-      "engines": {
-        "node": "6.* || 8.* || >= 10.*"
-      }
-    },
     "node_modules/get-intrinsic": {
       "version": "1.2.2",
       "resolved": "https://registry.npmjs.org/get-intrinsic/-/get-intrinsic-1.2.2.tgz",
@@ -1470,42 +1393,6 @@
         "node": ">= 0.8"
       }
     },
-    "node_modules/http-proxy": {
-      "version": "1.18.1",
-      "resolved": "https://registry.npmjs.org/http-proxy/-/http-proxy-1.18.1.tgz",
-      "integrity": "sha512-7mz/721AbnJwIVbnaSv1Cz3Am0ZLT/UBwkC92VlxhXv/k/BBQfM2fXElQNC27BVGr0uwUpplYPQM9LnaBMR5NQ==",
-      "dependencies": {
-        "eventemitter3": "^4.0.0",
-        "follow-redirects": "^1.0.0",
-        "requires-port": "^1.0.0"
-      },
-      "engines": {
-        "node": ">=8.0.0"
-      }
-    },
-    "node_modules/http-proxy-middleware": {
-      "version": "2.0.6",
-      "resolved": "https://registry.npmjs.org/http-proxy-middleware/-/http-proxy-middleware-2.0.6.tgz",
-      "integrity": "sha512-ya/UeJ6HVBYxrgYotAZo1KvPWlgB48kUJLDePFeneHsVujFaW5WNj2NgWCAE//B1Dl02BIfYlpNgBy8Kf8Rjmw==",
-      "dependencies": {
-        "@types/http-proxy": "^1.17.8",
-        "http-proxy": "^1.18.1",
-        "is-glob": "^4.0.1",
-        "is-plain-obj": "^3.0.0",
-        "micromatch": "^4.0.2"
-      },
-      "engines": {
-        "node": ">=12.0.0"
-      },
-      "peerDependencies": {
-        "@types/express": "^4.17.13"
-      },
-      "peerDependenciesMeta": {
-        "@types/express": {
-          "optional": true
-        }
-      }
-    },
     "node_modules/https-proxy-agent": {
       "version": "5.0.1",
       "resolved": "https://registry.npmjs.org/https-proxy-agent/-/https-proxy-agent-5.0.1.tgz",
@@ -1631,17 +1518,6 @@
         "node": ">=0.12.0"
       }
     },
-    "node_modules/is-plain-obj": {
-      "version": "3.0.0",
-      "resolved": "https://registry.npmjs.org/is-plain-obj/-/is-plain-obj-3.0.0.tgz",
-      "integrity": "sha512-gwsOE28k+23GP1B6vFl1oVh/WOzmawBrKwo5Ev6wMKzPkaXaCDIQKzLnvsA42DRlbVTWorkgTKIviAKCWkfUwA==",
-      "engines": {
-        "node": ">=10"
-      },
-      "funding": {
-        "url": "https://github.com/sponsors/sindresorhus"
-      }
-    },
     "node_modules/isexe": {
       "version": "2.0.0",
       "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz",
@@ -1676,15 +1552,6 @@
         "@sideway/pinpoint": "^2.0.0"
       }
     },
-    "node_modules/json-schema-to-openapi-schema": {
-      "version": "0.4.0",
-      "resolved": "https://registry.npmjs.org/json-schema-to-openapi-schema/-/json-schema-to-openapi-schema-0.4.0.tgz",
-      "integrity": "sha512-/DY8s4l28M5ZIJBhmcUFWbZChJV5v7RCA7RMVxubyD1l5KwIceUq6+EUnqQ2q3wh/2D3Zn8bNSeAu1i2X+sMHQ==",
-      "deprecated": "This package is no longer maintained. Use @openapi-contrib/json-schema-to-openapi-schema instead.",
-      "dependencies": {
-        "@cloudflare/json-schema-walker": "^0.1.1"
-      }
-    },
     "node_modules/json5": {
       "version": "2.2.3",
       "resolved": "https://registry.npmjs.org/json5/-/json5-2.2.3.tgz",
@@ -1816,7 +1683,8 @@
     "node_modules/make-error": {
       "version": "1.3.6",
       "resolved": "https://registry.npmjs.org/make-error/-/make-error-1.3.6.tgz",
-      "integrity": "sha512-s8UhlNe7vPKomQhC1qFelMokr/Sc3AgNbso3n74mVPA5LTZwkB9NlXf4XPamLxJE8h0gh73rM94xvwRT2CVInw=="
+      "integrity": "sha512-s8UhlNe7vPKomQhC1qFelMokr/Sc3AgNbso3n74mVPA5LTZwkB9NlXf4XPamLxJE8h0gh73rM94xvwRT2CVInw==",
+      "dev": true
     },
     "node_modules/media-typer": {
       "version": "0.3.0",
@@ -4951,11 +4819,6 @@
         "wrappy": "1"
       }
     },
-    "node_modules/openapi-types": {
-      "version": "12.1.3",
-      "resolved": "https://registry.npmjs.org/openapi-types/-/openapi-types-12.1.3.tgz",
-      "integrity": "sha512-N4YtSYJqghVu4iek2ZUvcN/0aqH1kRDuNqzcycDxhOUpg7GdvLa2F3DgS6yBNhInhv2r/6I0Flkn7CqL8+nIcw=="
-    },
     "node_modules/parseurl": {
       "version": "1.3.3",
       "resolved": "https://registry.npmjs.org/parseurl/-/parseurl-1.3.3.tgz",
@@ -4973,11 +4836,6 @@
         "util": "^0.10.3"
       }
     },
-    "node_modules/path-equal": {
-      "version": "1.2.5",
-      "resolved": "https://registry.npmjs.org/path-equal/-/path-equal-1.2.5.tgz",
-      "integrity": "sha512-i73IctDr3F2W+bsOWDyyVm/lqsXO47aY9nsFZUjTT/aljSbkxHxxCoyZ9UUrM8jK0JVod+An+rl48RCsvWM+9g=="
-    },
     "node_modules/path-is-absolute": {
       "version": "1.0.1",
       "resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz",
@@ -5165,19 +5023,6 @@
         "node": ">=8.10.0"
       }
     },
-    "node_modules/require-directory": {
-      "version": "2.1.1",
-      "resolved": "https://registry.npmjs.org/require-directory/-/require-directory-2.1.1.tgz",
-      "integrity": "sha512-fGxEI7+wsG9xrvdjsrlmL22OMTTiHRwAMroiEeMgq8gzoLC/PQr7RsRDSTLUg/bZAZtF+TVIkHc6/4RIKrui+Q==",
-      "engines": {
-        "node": ">=0.10.0"
-      }
-    },
-    "node_modules/requires-port": {
-      "version": "1.0.0",
-      "resolved": "https://registry.npmjs.org/requires-port/-/requires-port-1.0.0.tgz",
-      "integrity": "sha512-KigOCHcocU3XODJxsu8i/j8T9tzT4adHiecwORRQ0ZZFcp7ahwXuRU1m+yuO90C5ZUyGeGfocHDI14M3L3yDAQ=="
-    },
     "node_modules/resolve": {
       "version": "1.22.8",
       "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.8.tgz",
@@ -5278,14 +5123,6 @@
         }
       ]
     },
-    "node_modules/safe-stable-stringify": {
-      "version": "2.4.3",
-      "resolved": "https://registry.npmjs.org/safe-stable-stringify/-/safe-stable-stringify-2.4.3.tgz",
-      "integrity": "sha512-e2bDA2WJT0wxseVd4lsDP4+3ONX6HpMXQa1ZhFQ7SU+GjvORCmShbCMltrtIDfkYhVHrOcPtj+KhmDBdPdZD1g==",
-      "engines": {
-        "node": ">=10"
-      }
-    },
     "node_modules/safer-buffer": {
       "version": "2.1.2",
       "resolved": "https://registry.npmjs.org/safer-buffer/-/safer-buffer-2.1.2.tgz",
@@ -5582,16 +5419,16 @@
       }
     },
     "node_modules/swagger-ui-dist": {
-      "version": "5.14.0",
-      "resolved": "https://registry.npmjs.org/swagger-ui-dist/-/swagger-ui-dist-5.14.0.tgz",
-      "integrity": "sha512-7qsKvc3gs5dnEIOclY4xkzacY85Pu9a/Gzkf+eezKLQ4BpErlI8BxYWADhnCx6PmFyU4fxH4AMKH+/d3Kml0Gg=="
+      "version": "5.17.0",
+      "resolved": "https://registry.npmjs.org/swagger-ui-dist/-/swagger-ui-dist-5.17.0.tgz",
+      "integrity": "sha512-PtEozc87rN6i6rqLYNVTK+1ZAYmCMy6poU6I2MOJXD19BVv6D7U9zwS8geRbtfamCM5yUwWkSNQKWGK58vculg=="
     },
     "node_modules/swagger-ui-express": {
-      "version": "4.6.3",
-      "resolved": "https://registry.npmjs.org/swagger-ui-express/-/swagger-ui-express-4.6.3.tgz",
-      "integrity": "sha512-CDje4PndhTD2HkgyKH3pab+LKspDeB/NhPN2OF1j+piYIamQqBYwAXWESOT1Yju2xFg51bRW9sUng2WxDjzArw==",
+      "version": "5.0.0",
+      "resolved": "https://registry.npmjs.org/swagger-ui-express/-/swagger-ui-express-5.0.0.tgz",
+      "integrity": "sha512-tsU9tODVvhyfkNSvf03E6FAk+z+5cU3lXAzMy6Pv4av2Gt2xA0++fogwC4qo19XuFf6hdxevPuVCSKFuMHJhFA==",
       "dependencies": {
-        "swagger-ui-dist": ">=4.11.0"
+        "swagger-ui-dist": ">=5.0.0"
       },
       "engines": {
         "node": ">= v0.10.32"
@@ -5671,6 +5508,7 @@
       "version": "10.9.2",
       "resolved": "https://registry.npmjs.org/ts-node/-/ts-node-10.9.2.tgz",
       "integrity": "sha512-f0FFpIdcHgn8zcPSbf1dRevwt047YMnaiJM3u2w2RewrB+fob/zePZcrOyQoLMMO7aBIddLcQIEK5dYjkLnGrQ==",
+      "dev": true,
       "dependencies": {
         "@cspotcode/source-map-support": "^0.8.0",
         "@tsconfig/node10": "^1.0.7",
@@ -5817,81 +5655,6 @@
         "node": ">=6"
       }
     },
-    "node_modules/tspec": {
-      "version": "0.1.112",
-      "resolved": "https://registry.npmjs.org/tspec/-/tspec-0.1.112.tgz",
-      "integrity": "sha512-rkTAZ5czVp/ZrRLD0Vydl2xHz+Tw+rZkya64Fysk1qMpHnQDIMyItqgY6IQ7tj2jxB9Y22kuRbCfxzrzznMU6g==",
-      "dependencies": {
-        "debug": "^4.3.4",
-        "express": "^4.18.2",
-        "glob": "^8.1.0",
-        "http-proxy-middleware": "^2.0.6",
-        "json-schema-to-openapi-schema": "^0.4.0",
-        "openapi-types": "^12.0.2",
-        "swagger-ui-express": "^4.6.2",
-        "typescript": "~5.1.0",
-        "typescript-json-schema": "^0.62.0",
-        "yargs": "^17.7.1"
-      },
-      "bin": {
-        "tspec": "dist/cli.js"
-      },
-      "engines": {
-        "node": ">=12.0.0"
-      },
-      "peerDependencies": {
-        "express": "^4.17.1"
-      }
-    },
-    "node_modules/tspec/node_modules/brace-expansion": {
-      "version": "2.0.1",
-      "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz",
-      "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==",
-      "dependencies": {
-        "balanced-match": "^1.0.0"
-      }
-    },
-    "node_modules/tspec/node_modules/glob": {
-      "version": "8.1.0",
-      "resolved": "https://registry.npmjs.org/glob/-/glob-8.1.0.tgz",
-      "integrity": "sha512-r8hpEjiQEYlF2QU0df3dS+nxxSIreXQS1qRhMJM0Q5NDdR386C7jb7Hwwod8Fgiuex+k0GFjgft18yvxm5XoCQ==",
-      "dependencies": {
-        "fs.realpath": "^1.0.0",
-        "inflight": "^1.0.4",
-        "inherits": "2",
-        "minimatch": "^5.0.1",
-        "once": "^1.3.0"
-      },
-      "engines": {
-        "node": ">=12"
-      },
-      "funding": {
-        "url": "https://github.com/sponsors/isaacs"
-      }
-    },
-    "node_modules/tspec/node_modules/minimatch": {
-      "version": "5.1.6",
-      "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-5.1.6.tgz",
-      "integrity": "sha512-lKwV/1brpG6mBUFHtb7NUmtABCb2WZZmm2wNiOA5hAb8VdCS4B3dtMWyvcoViccwAW/COERjXLt0zP1zXUN26g==",
-      "dependencies": {
-        "brace-expansion": "^2.0.1"
-      },
-      "engines": {
-        "node": ">=10"
-      }
-    },
-    "node_modules/tspec/node_modules/typescript": {
-      "version": "5.1.6",
-      "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.1.6.tgz",
-      "integrity": "sha512-zaWCozRZ6DLEWAWFrVDz1H6FVXzUSfTy5FUMWsQlU8Ym5JP9eO4xkTIROFCQvhQf61z6O/G6ugw3SgAnvvm+HA==",
-      "bin": {
-        "tsc": "bin/tsc",
-        "tsserver": "bin/tsserver"
-      },
-      "engines": {
-        "node": ">=14.17"
-      }
-    },
     "node_modules/type-is": {
       "version": "1.6.18",
       "resolved": "https://registry.npmjs.org/type-is/-/type-is-1.6.18.tgz",
@@ -5908,60 +5671,7 @@
       "version": "5.3.3",
       "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.3.3.tgz",
       "integrity": "sha512-pXWcraxM0uxAS+tN0AG/BF2TyqmHO014Z070UsJ+pFvYuRSq8KH8DmWpnbXe0pEPDHXZV3FcAbJkijJ5oNEnWw==",
-      "bin": {
-        "tsc": "bin/tsc",
-        "tsserver": "bin/tsserver"
-      },
-      "engines": {
-        "node": ">=14.17"
-      }
-    },
-    "node_modules/typescript-json-schema": {
-      "version": "0.62.0",
-      "resolved": "https://registry.npmjs.org/typescript-json-schema/-/typescript-json-schema-0.62.0.tgz",
-      "integrity": "sha512-qRO6pCgyjKJ230QYdOxDRpdQrBeeino4v5p2rYmSD72Jf4rD3O+cJcROv46sQukm46CLWoeusqvBgKpynEv25g==",
-      "dependencies": {
-        "@types/json-schema": "^7.0.9",
-        "@types/node": "^16.9.2",
-        "glob": "^7.1.7",
-        "path-equal": "^1.2.5",
-        "safe-stable-stringify": "^2.2.0",
-        "ts-node": "^10.9.1",
-        "typescript": "~5.1.0",
-        "yargs": "^17.1.1"
-      },
-      "bin": {
-        "typescript-json-schema": "bin/typescript-json-schema"
-      }
-    },
-    "node_modules/typescript-json-schema/node_modules/@types/node": {
-      "version": "16.18.95",
-      "resolved": "https://registry.npmjs.org/@types/node/-/node-16.18.95.tgz",
-      "integrity": "sha512-z9w+CcR7ahc7UhsKe+PGB25nmPmCERQBAdLdFHhoZ6+FfgSr7gUvdQI0eLH2t7ue8u5wKsLdde6cHKPjhC8vGg=="
-    },
-    "node_modules/typescript-json-schema/node_modules/glob": {
-      "version": "7.2.3",
-      "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz",
-      "integrity": "sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==",
-      "dependencies": {
-        "fs.realpath": "^1.0.0",
-        "inflight": "^1.0.4",
-        "inherits": "2",
-        "minimatch": "^3.1.1",
-        "once": "^1.3.0",
-        "path-is-absolute": "^1.0.0"
-      },
-      "engines": {
-        "node": "*"
-      },
-      "funding": {
-        "url": "https://github.com/sponsors/isaacs"
-      }
-    },
-    "node_modules/typescript-json-schema/node_modules/typescript": {
-      "version": "5.1.6",
-      "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.1.6.tgz",
-      "integrity": "sha512-zaWCozRZ6DLEWAWFrVDz1H6FVXzUSfTy5FUMWsQlU8Ym5JP9eO4xkTIROFCQvhQf61z6O/G6ugw3SgAnvvm+HA==",
+      "dev": true,
       "bin": {
         "tsc": "bin/tsc",
         "tsserver": "bin/tsserver"
@@ -6018,7 +5728,8 @@
     "node_modules/v8-compile-cache-lib": {
       "version": "3.0.1",
       "resolved": "https://registry.npmjs.org/v8-compile-cache-lib/-/v8-compile-cache-lib-3.0.1.tgz",
-      "integrity": "sha512-wa7YjyUGfNZngI/vtK0UHAN+lgDCxBPCylVXGp0zu59Fz5aiGtNXaq3DhIov063MorB+VfufLh3JlF2KdTK3xg=="
+      "integrity": "sha512-wa7YjyUGfNZngI/vtK0UHAN+lgDCxBPCylVXGp0zu59Fz5aiGtNXaq3DhIov063MorB+VfufLh3JlF2KdTK3xg==",
+      "dev": true
     },
     "node_modules/vary": {
       "version": "1.1.2",
@@ -6177,48 +5888,16 @@
         "node": ">=0.4"
       }
     },
-    "node_modules/y18n": {
-      "version": "5.0.8",
-      "resolved": "https://registry.npmjs.org/y18n/-/y18n-5.0.8.tgz",
-      "integrity": "sha512-0pfFzegeDWJHJIAmTLRP2DwHjdF5s7jo9tuztdQxAhINCdvS+3nGINqPd00AphqJR/0LhANUS6/+7SCb98YOfA==",
-      "engines": {
-        "node": ">=10"
-      }
-    },
     "node_modules/yallist": {
       "version": "4.0.0",
       "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz",
       "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A=="
     },
-    "node_modules/yargs": {
-      "version": "17.7.2",
-      "resolved": "https://registry.npmjs.org/yargs/-/yargs-17.7.2.tgz",
-      "integrity": "sha512-7dSzzRQ++CKnNI/krKnYRV7JKKPUXMEh61soaHKg9mrWEhzFWhFnxPxGl+69cD1Ou63C13NUPCnmIcrvqCuM6w==",
-      "dependencies": {
-        "cliui": "^8.0.1",
-        "escalade": "^3.1.1",
-        "get-caller-file": "^2.0.5",
-        "require-directory": "^2.1.1",
-        "string-width": "^4.2.3",
-        "y18n": "^5.0.5",
-        "yargs-parser": "^21.1.1"
-      },
-      "engines": {
-        "node": ">=12"
-      }
-    },
-    "node_modules/yargs-parser": {
-      "version": "21.1.1",
-      "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-21.1.1.tgz",
-      "integrity": "sha512-tVpsJW7DdjecAiFpbIB1e3qxIQsE6NoPc5/eTdrbbIC4h0LVsWhnoa3g+m2HclBIujHzsxZ4VJVA+GUuc2/LBw==",
-      "engines": {
-        "node": ">=12"
-      }
-    },
     "node_modules/yn": {
       "version": "3.1.1",
       "resolved": "https://registry.npmjs.org/yn/-/yn-3.1.1.tgz",
       "integrity": "sha512-Ux4ygGWsu2c7isFWe8Yu1YluJmqVhxqK2cLXNQA5AcC3QfbGNpM7fu0Y8b/z16pXLnFxZYvWhd3fhBY9DLmC6Q==",
+      "dev": true,
       "engines": {
         "node": ">=6"
       }

package.json

@@ -5,7 +5,7 @@
   "main": "dist/index.js",
   "scripts": {
     "start": "rimraf dist && tsc && tsc-alias && node dist/index.js",
-    "start:dev": "ts-node-dev -r tsconfig-paths/register src/index.ts",
+    "start:dev": "ts-node-dev --files -r tsconfig-paths/register src/index.ts",
     "build": "tsc",
     "lint": "eslint . --ext .ts"
   },
@@ -13,6 +13,7 @@
   "license": "ISC",
   "devDependencies": {
     "@types/express": "^4.17.21",
+    "@types/swagger-ui-express": "^4.1.6",
     "nodemon": "^3.0.2",
     "ts-node": "^10.9.2",
     "ts-node-dev": "^2.0.0",
@@ -36,7 +37,7 @@
     "mongoose": "^8.0.3",
     "npm": "^10.2.5",
     "path": "^0.12.7",
-    "tsc-alias": "^1.8.8",
-    "tspec": "^0.1.112"
+    "swagger-ui-express": "^5.0.0",
+    "tsc-alias": "^1.8.8"
   }
 }

src/lib/decorators/prefix.decorator.ts

@@ -1,6 +1,7 @@
+import { swaggerRegistry } from "@lib/swagger/swagger";
 import { BaseController } from "../controllers/controller.base";
 
-export const Prefix = (prefix: string) => {
+export const Controller = (prefix: string) => {
   return (target: typeof BaseController) => {
     const originalConstructor = target;
     const newConstructor: any = function (...args: any[]) {
@@ -9,6 +10,17 @@ export const Prefix = (prefix: string) => {
       return instance;
     };
     newConstructor.prototype = originalConstructor.prototype;
+    swaggerRegistry.setControllerPrefix(
+      target.prototype.constructor.name,
+      prefix
+    );
+    swaggerRegistry.setControllerTags(target.prototype.constructor.name, [
+      prefix
+        .split("/")
+        .slice(1)
+        .map((tag) => tag.charAt(0).toUpperCase() + tag.slice(1))
+        .join(" - "),
+    ]);
     return newConstructor;
   };
 };

src/lib/decorators/swagger-controller.decorator.ts

@@ -0,0 +1,8 @@
+import { swaggerRegistry } from "@lib/swagger/swagger";
+
+export const SwaggerController = (path: string) => {
+  return (target: any) => {
+    target = target.prototype.constructor.name;
+    swaggerRegistry.setControllerPrefix(target, path);
+  };
+};

src/lib/decorators/swagger-request.decorator.ts

@@ -0,0 +1,22 @@
+import { swaggerRegistry } from "@lib/swagger/swagger";
+
+export const SwaggerRequest = (joiSchema: any) => {
+  return (target: any, propertyKey: string) => {
+    const schema: any = {
+      type: "object",
+      properties: {},
+    };
+
+    const properties = Object.getOwnPropertyNames(joiSchema.describe().keys);
+    properties.forEach((property) => {
+      schema.properties[property] = {
+        type: joiSchema.describe().keys[property].type,
+      };
+    });
+
+    swaggerRegistry.updateRoute(target.constructor.name, {
+      propertyKey,
+      request: schema,
+    });
+  };
+};

src/lib/decorators/swagger-response.decorator.ts

@@ -0,0 +1,74 @@
+import { swaggerRegistry } from "@lib/swagger/swagger";
+import { instanceToPlain } from "class-transformer";
+
+export const SwaggerResponse = (responseClass: any) => {
+  return (target: any, propertyKey: string) => {
+    const isArray = Array.isArray(responseClass);
+    responseClass = isArray ? responseClass[0] : responseClass;
+
+    // turn class to swagger schema
+    const schema: any = {
+      type: "object",
+      properties: {},
+    };
+
+    // get class properties
+    let properties = [];
+    let instance;
+    try {
+      instance = new responseClass();
+      properties = Object.getOwnPropertyNames(instanceToPlain(instance));
+    } catch (e) {
+      instance = responseClass;
+      properties = Object.getOwnPropertyNames(instance);
+    }
+    properties.forEach((property) => {
+      schema.properties[property] = {
+        type: (instance[property] && typeof instance[property]) || "string",
+      };
+    });
+
+    if (isArray) {
+      schema.type = "array";
+      schema.items = {
+        type: "object",
+        properties: schema.properties,
+      };
+    }
+
+    const standardResponseSchema: any = {
+      type: "object",
+      properties: {
+        data: schema,
+        message: {
+          type: "string",
+        },
+        status: {
+          type: "string",
+        },
+      },
+    };
+
+    if (isArray) {
+      standardResponseSchema.properties.meta = {
+        type: "object",
+        properties: {
+          total: {
+            type: "number",
+          },
+          page: {
+            type: "number",
+          },
+          limit: {
+            type: "number",
+          },
+        },
+      };
+    }
+
+    swaggerRegistry.updateRoute(target.constructor.name, {
+      propertyKey,
+      response: standardResponseSchema,
+    });
+  };
+};

src/lib/decorators/swagger-routes.decorator.ts

@@ -0,0 +1,21 @@
+import { swaggerRegistry } from "@lib/swagger/swagger";
+
+export const SwaggerRoute = (
+  path: string = "",
+  method: "get" | "post" | "put" | "patch" | "delete"
+) => {
+  return (target: any, propertyKey: string) => {
+    swaggerRegistry.updateRoute(target.constructor.name, {
+      propertyKey,
+      path,
+      method,
+    });
+  };
+};
+
+export const SwaggerGet = (path: string = "") => SwaggerRoute(path, "get");
+export const SwaggerPost = (path: string = "") => SwaggerRoute(path, "post");
+export const SwaggerPut = (path: string = "") => SwaggerRoute(path, "put");
+export const SwaggerPatch = (path: string = "") => SwaggerRoute(path, "patch");
+export const SwaggerDelete = (path: string = "") =>
+  SwaggerRoute(path, "delete");

src/lib/decorators/swagger-tags.decorator.ts

@@ -0,0 +1,9 @@
+import { swaggerRegistry } from "@lib/swagger/swagger";
+
+export const SwaggerTags = (...tags: string[]) => {
+  if (!tags.length) return;
+  return (target: any) => {
+    target = target.prototype.constructor.name;
+    swaggerRegistry.setControllerTags(target, tags);
+  };
+};

src/lib/swagger/swagger.ts

@@ -0,0 +1,165 @@
+/**
+ * Swagger registry class.
+ */
+class SwaggerRegistry {
+  public static registry = new Map<
+    any,
+    {
+      routes: {
+        propertyKey: string;
+        path?: string;
+        method?: "get" | "post" | "put" | "patch" | "delete";
+        request?: any;
+        response?: any;
+      }[];
+      prefix: string;
+      tags?: string[];
+    }
+  >();
+
+  public initControllerIfNotExists(controller: any, prefix: string = "") {
+    if (!SwaggerRegistry.registry.has(controller)) {
+      SwaggerRegistry.registry.set(controller, {
+        routes: [],
+        prefix,
+      });
+    }
+  }
+
+  public setControllerPrefix(controller: any, prefix: string) {
+    this.initControllerIfNotExists(controller);
+    const data = SwaggerRegistry.registry.get(controller);
+    data.prefix = prefix;
+    SwaggerRegistry.registry.set(controller, data);
+  }
+
+  public updateRoute(
+    controller: any,
+    params: {
+      propertyKey: string;
+      path?: string;
+      method?: "get" | "post" | "put" | "patch" | "delete";
+      request?: any;
+      response?: any;
+    }
+  ) {
+    this.initControllerIfNotExists(controller);
+    const data = SwaggerRegistry.registry.get(controller);
+
+    // delete undefined keys
+    Object.keys(params).forEach(
+      (key) => params[key] === undefined && delete params[key]
+    );
+
+    const route = data.routes.find(
+      (route) => route.propertyKey === params.propertyKey
+    );
+    if (route) {
+      Object.assign(route, params);
+    } else {
+      data.routes.push(params);
+    }
+
+    SwaggerRegistry.registry.set(controller, data);
+  }
+
+  public setControllerTags(controller: any, tags: string[]) {
+    this.initControllerIfNotExists(controller);
+    const data = SwaggerRegistry.registry.get(controller);
+    data.tags = tags;
+    SwaggerRegistry.registry.set(controller, data);
+  }
+
+  public generateSwaggerDocument() {
+    const paths: any = {};
+    SwaggerRegistry.registry.forEach((value) => {
+      const controllerData = value;
+
+      controllerData.routes.forEach((route) => {
+        route.path = `/api/v1${controllerData.prefix}${route.path}`;
+
+        if (!paths[route.path]) {
+          paths[route.path] = {};
+        }
+
+        paths[route.path][route.method] = {
+          security: [
+            {
+              bearerAuth: [],
+            },
+          ],
+          tags: controllerData.tags,
+          responses: {
+            200: {
+              description: "Success",
+              content: {
+                "application/json": {
+                  schema: route.response,
+                },
+              },
+            },
+          },
+        };
+
+        if (route.request) {
+          paths[route.path][route.method].requestBody = {
+            content: {
+              "application/json": {
+                schema: route.request,
+              },
+            },
+          };
+        }
+
+        if (!paths[route.path].summary) {
+          paths[route.path].summary = route.propertyKey;
+        }
+
+        if (!paths[route.path].description) {
+          paths[route.path].description = route.propertyKey;
+        }
+
+        if (!paths[route.path].parameters) {
+          paths[route.path].parameters = [];
+        }
+
+        if (!paths[route.path].responses) {
+          paths[route.path].responses = [];
+        }
+      });
+    });
+
+    const document = {
+      openapi: "3.0.0",
+      info: {
+        title: "Express TypeScript Swagger",
+        version: "1.0.0",
+        description:
+          "API documentation using Swagger and Express with TypeScript.",
+      },
+      servers: [
+        {
+          url: "http://localhost:3000",
+        },
+      ],
+      security: [
+        {
+          bearerAuth: [],
+        },
+      ],
+      paths,
+      components: {
+        securitySchemes: {
+          bearerAuth: {
+            type: "http",
+            scheme: "bearer",
+            bearerFormat: "JWT",
+          },
+        },
+      },
+    };
+
+    return document;
+  }
+}
+export const swaggerRegistry = new SwaggerRegistry();

src/modules/console/modules/admins/controllers/admins.controller.docs.ts

@@ -1,41 +0,0 @@
-import { AdminSerialization } from "modules/console/common/serializers/admin.serialization";
-import { Tspec } from "tspec";
-import { ICreateAdmin } from "../validations/create-admin.validation";
-import { AdminsController } from "./admins.controller";
-
-export type AdminsControllerSpecs = Tspec.DefineApiSpec<{
-  basePath: "/api/v1/console/admins";
-  tags: ["console/admins"];
-  paths: {
-    "/": {
-      get: {
-        handler: AdminsController["list"];
-      };
-      post: {
-        body: ICreateAdmin;
-        handler: AdminsController["create"];
-      };
-    };
-    "/{id}": {
-      get: {
-        path: {
-          id: string;
-        };
-        handler: AdminsController["get"];
-      };
-      patch: {
-        path: {
-          id: string;
-        };
-        body: ICreateAdmin;
-        handler: AdminsController["update"];
-      };
-      delete: {
-        path: {
-          id: string;
-        };
-        handler: AdminsController["delete"];
-      };
-    };
-  }
-}>;

src/modules/console/modules/admins/controllers/admins.controller.ts

@@ -1,10 +1,13 @@
 import { asyncHandler } from "@helpers/async-handler";
 import { paramsValidator, bodyValidator } from "@helpers/validation.helper";
 import { BaseController } from "@lib/controllers/controller.base";
-import { Prefix } from "@lib/decorators/prefix.decorator";
+import { Controller } from "@lib/decorators/prefix.decorator";
 import { Request, Response } from "express";
 import { AdminsService } from "../services/admins.service";
-import { ICreateAdmin, createAdminSchema } from "../validations/create-admin.validation";
+import {
+  ICreateAdmin,
+  createAdminSchema,
+} from "../validations/create-admin.validation";
 import { parsePaginationQuery } from "@helpers/pagination";
 import { JsonResponse } from "@lib/responses/json-response";
 import { ControllerMiddleware } from "@lib/decorators/controller-middleware.decorator";
@@ -13,8 +16,16 @@ import { Role } from "@common/enums/role.enum";
 import { serialize } from "@helpers/serialize";
 import { AdminSerialization } from "modules/console/common/serializers/admin.serialization";
 import { IJSONSuccessResponse } from "@lib/responses/json-responses";
+import {
+  SwaggerDelete,
+  SwaggerGet,
+  SwaggerPatch,
+  SwaggerPost,
+} from "@lib/decorators/swagger-routes.decorator";
+import { SwaggerResponse } from "@lib/decorators/swagger-response.decorator";
+import { SwaggerRequest } from "@lib/decorators/swagger-request.decorator";
 
-@Prefix("/console/admins")
+@Controller("/console/admins")
 @ControllerMiddleware(AdminGuardMiddleware({ roles: [Role.SUPER_ADMIN] }))
 export class AdminsController extends BaseController {
   private adminsService = new AdminsService();
@@ -40,6 +51,8 @@ export class AdminsController extends BaseController {
     );
   }
 
+  @SwaggerGet()
+  @SwaggerResponse([AdminSerialization])
   list = async (
     req: Request,
     res: Response<IJSONSuccessResponse<AdminSerialization[]>>
@@ -59,6 +72,8 @@ export class AdminsController extends BaseController {
     );
   };
 
+  @SwaggerGet("/:id")
+  @SwaggerResponse(AdminSerialization)
   get = async (
     req: Request<{ id: string }>,
     res: Response<IJSONSuccessResponse<AdminSerialization>>
@@ -75,6 +90,9 @@ export class AdminsController extends BaseController {
     );
   };
 
+  @SwaggerPost()
+  @SwaggerResponse(AdminSerialization)
+  @SwaggerRequest(createAdminSchema)
   create = async (
     req: Request<{}, {}, ICreateAdmin>,
     res: Response<IJSONSuccessResponse<AdminSerialization>>
@@ -90,6 +108,9 @@ export class AdminsController extends BaseController {
     );
   };
 
+  @SwaggerPatch("/:id")
+  @SwaggerResponse(AdminSerialization)
+  @SwaggerRequest(createAdminSchema)
   update = async (
     req: Request<{ id: string }, {}, ICreateAdmin>,
     res: Response<IJSONSuccessResponse<AdminSerialization>>
@@ -109,6 +130,8 @@ export class AdminsController extends BaseController {
     );
   };
 
+  @SwaggerDelete("/:id")
+  @SwaggerResponse(AdminSerialization)
   delete = async (
     req: Request<{ id: string }>,
     res: Response<IJSONSuccessResponse<AdminSerialization>>

src/modules/console/modules/auth/controllers/auth.controller.ts

@@ -2,14 +2,17 @@ import { asyncHandler } from "@helpers/async-handler";
 import { serialize } from "@helpers/serialize";
 import { bodyValidator } from "@helpers/validation.helper";
 import { BaseController } from "@lib/controllers/controller.base";
-import { Prefix } from "@lib/decorators/prefix.decorator";
+import { Controller } from "@lib/decorators/prefix.decorator";
 import { JsonResponse } from "@lib/responses/json-response";
 import { Request, Response } from "express";
 import { loginValidationSchema } from "modules/users/modules/auth/validation/login.validation";
 import { ConsoleAuthService } from "../services/auth.service";
 import { AdminSerialization } from "modules/console/common/serializers/admin.serialization";
+import { SwaggerRequest } from "@lib/decorators/swagger-request.decorator";
+import { SwaggerResponse } from "@lib/decorators/swagger-response.decorator";
+import { SwaggerPost } from "@lib/decorators/swagger-routes.decorator";
 
-@Prefix("/console/auth")
+@Controller("/console/auth")
 export class ConsoleAuthController extends BaseController {
   private authService = new ConsoleAuthService();
 
@@ -21,6 +24,9 @@ export class ConsoleAuthController extends BaseController {
     );
   }
 
+  @SwaggerPost('/login')
+  @SwaggerRequest(loginValidationSchema)
+  @SwaggerResponse(AdminSerialization)
   login = async (req: Request, res: Response): Promise<Response> => {
     const { admin, token } = await this.authService.login(req.body);
 

src/modules/console/modules/equipments/controllers/equipments.controller.ts

@@ -4,7 +4,7 @@ import { parsePaginationQuery } from "@helpers/pagination";
 import { asyncHandler } from "@helpers/async-handler";
 import { paramsValidator, bodyValidator } from "@helpers/validation.helper";
 import { BaseController } from "@lib/controllers/controller.base";
-import { Prefix } from "@lib/decorators/prefix.decorator";
+import { Controller } from "@lib/decorators/prefix.decorator";
 import { serialize } from "@helpers/serialize";
 import { ControllerMiddleware } from "@lib/decorators/controller-middleware.decorator";
 import { AdminGuardMiddleware } from "modules/console/common/guards/admins.guard";
@@ -12,90 +12,112 @@ import { EquipmentsService } from "../services/equipments.service";
 import { createEquipmentchema } from "../validations/create-equipment.validation";
 import { updateEquipmentSchema } from "../validations/update-equipment.validation";
 import { EquipmentSerialization } from "@common/serializers/muscle.serialization";
+import {
+  SwaggerDelete,
+  SwaggerGet,
+  SwaggerPatch,
+  SwaggerPost,
+} from "@lib/decorators/swagger-routes.decorator";
+import { SwaggerResponse } from "@lib/decorators/swagger-response.decorator";
+import { SwaggerRequest } from "@lib/decorators/swagger-request.decorator";
 
-@Prefix("/console/equipments")
+@Controller("/console/equipments")
 @ControllerMiddleware(AdminGuardMiddleware({}))
 export class EquipmentsController extends BaseController {
-    private equipmentsService = new EquipmentsService();
+  private equipmentsService = new EquipmentsService();
 
-    setRoutes() {
-        this.router.get("/", asyncHandler(this.list));
-        this.router.get("/:id", paramsValidator("id"), asyncHandler(this.get));
-        this.router.post("/",
-            bodyValidator(createEquipmentchema),
-            asyncHandler(this.create));
-        this.router.patch(
-            "/:id",
-            paramsValidator("id"),
-            bodyValidator(updateEquipmentSchema),
-            asyncHandler(this.update)
-        );
-        this.router.delete(
-            "/:id",
-            paramsValidator("id"),
-            asyncHandler(this.delete)
-        );
-    }
+  setRoutes() {
+    this.router.get("/", asyncHandler(this.list));
+    this.router.get("/:id", paramsValidator("id"), asyncHandler(this.get));
+    this.router.post(
+      "/",
+      bodyValidator(createEquipmentchema),
+      asyncHandler(this.create)
+    );
+    this.router.patch(
+      "/:id",
+      paramsValidator("id"),
+      bodyValidator(updateEquipmentSchema),
+      asyncHandler(this.update)
+    );
+    this.router.delete(
+      "/:id",
+      paramsValidator("id"),
+      asyncHandler(this.delete)
+    );
+  }
 
-    list = async (req: Request, res: Response) => {
-        const paginationQuery = parsePaginationQuery(req.query);
-        const { docs, paginationData } = await this.equipmentsService.list(
-            {},
-            paginationQuery
-        );
+  @SwaggerGet()
+  @SwaggerResponse([EquipmentSerialization])
+  list = async (req: Request, res: Response) => {
+    const paginationQuery = parsePaginationQuery(req.query);
+    const { docs, paginationData } = await this.equipmentsService.list(
+      {},
+      paginationQuery
+    );
 
-        return JsonResponse.success(
-            {
-                data: serialize(docs, EquipmentSerialization),
-                meta: paginationData,
-            },
-            res
-        );
-    };
+    return JsonResponse.success(
+      {
+        data: serialize(docs, EquipmentSerialization),
+        meta: paginationData,
+      },
+      res
+    );
+  };
 
-    get = async (req: Request, res: Response) => {
-        const data = await this.equipmentsService.findOneOrFail({
-            _id: req.params.id,
-        });
-        return JsonResponse.success(
-            {
-                data: serialize(data.toJSON(), EquipmentSerialization),
-            },
-            res
-        );
-    };
+  @SwaggerGet("/{id}")
+  @SwaggerResponse(EquipmentSerialization)
+  get = async (req: Request, res: Response) => {
+    const data = await this.equipmentsService.findOneOrFail({
+      _id: req.params.id,
+    });
+    return JsonResponse.success(
+      {
+        data: serialize(data.toJSON(), EquipmentSerialization),
+      },
+      res
+    );
+  };
 
-    create = async (req: Request, res: Response) => {
-        const data = await this.equipmentsService.create(req.body);
-        return JsonResponse.success(
-            {
-                status: 201,
-                data: serialize(data.toJSON(), EquipmentSerialization),
-            },
-            res
-        );
-    };
+  @SwaggerPost()
+  @SwaggerResponse(EquipmentSerialization)
+  @SwaggerRequest(createEquipmentchema)
+  create = async (req: Request, res: Response) => {
+    const data = await this.equipmentsService.create(req.body);
+    return JsonResponse.success(
+      {
+        status: 201,
+        data: serialize(data.toJSON(), EquipmentSerialization),
+      },
+      res
+    );
+  };
 
-    update = async (req: Request, res: Response) => {
-        const data = await this.equipmentsService.updateOne(
-            { _id: req.params.id },
-            req.body
-        );
-        return JsonResponse.success(
-            {
-                data: serialize(data.toJSON(), EquipmentSerialization),
-            },
-            res
-        );
-    };
+  @SwaggerPatch("/{id}")
+  @SwaggerResponse(EquipmentSerialization)
+  @SwaggerRequest(updateEquipmentSchema)
+  update = async (req: Request, res: Response) => {
+    const data = await this.equipmentsService.updateOne(
+      { _id: req.params.id },
+      req.body
+    );
+    return JsonResponse.success(
+      {
+        data: serialize(data.toJSON(), EquipmentSerialization),
+      },
+      res
+    );
+  };
 
-    delete = async (req: Request, res: Response) => {
-        const data = await this.equipmentsService.deleteOne({ _id: req.params.id });
-        return JsonResponse.success(
-            {
-                data: serialize(data.toJSON(), EquipmentSerialization),
-            },
-            res
-        );
-    };
-};
+  @SwaggerDelete("/{id}")
+  @SwaggerResponse(EquipmentSerialization)
+  delete = async (req: Request, res: Response) => {
+    const data = await this.equipmentsService.deleteOne({ _id: req.params.id });
+    return JsonResponse.success(
+      {
+        data: serialize(data.toJSON(), EquipmentSerialization),
+      },
+      res
+    );
+  };
+}

src/modules/console/modules/exercises/controllers/exercises.controller.ts

@@ -4,7 +4,7 @@ import { parsePaginationQuery } from "@helpers/pagination";
 import { paramsValidator, bodyValidator } from "@helpers/validation.helper";
 import { BaseController } from "@lib/controllers/controller.base";
 import { ControllerMiddleware } from "@lib/decorators/controller-middleware.decorator";
-import { Prefix } from "@lib/decorators/prefix.decorator";
+import { Controller } from "@lib/decorators/prefix.decorator";
 import { JsonResponse } from "@lib/responses/json-response";
 import { AdminGuardMiddleware } from "modules/console/common/guards/admins.guard";
 import { ExercisesService } from "../services/exercises.service";
@@ -12,8 +12,11 @@ import { Request, Response } from "express";
 import { serialize } from "@helpers/serialize";
 import { createExerciseSchema } from "../validations/create-excercise.validation";
 import { updateExerciseSchema } from "../validations/update-excercise.validation";
+import { SwaggerDelete, SwaggerGet, SwaggerPatch, SwaggerPost } from "@lib/decorators/swagger-routes.decorator";
+import { SwaggerResponse } from "@lib/decorators/swagger-response.decorator";
+import { SwaggerRequest } from "@lib/decorators/swagger-request.decorator";
 
-@Prefix("/console/exercises")
+@Controller("/console/exercises")
 @ControllerMiddleware(AdminGuardMiddleware({}))
 export class ExercisesController extends BaseController {
   private exercisesService = new ExercisesService();
@@ -39,6 +42,8 @@ export class ExercisesController extends BaseController {
     );
   }
 
+  @SwaggerGet()
+  @SwaggerResponse([ExerciseSerialization])
   list = async (req: Request, res: Response) => {
     const paginationQuery = parsePaginationQuery(req.query);
     const { docs, paginationData } = await this.exercisesService.list(
@@ -55,6 +60,8 @@ export class ExercisesController extends BaseController {
     );
   };
 
+  @SwaggerGet("/:id")
+  @SwaggerResponse(ExerciseSerialization)
   get = async (req: Request, res: Response) => {
     const data = await this.exercisesService.findOneOrFail({
       _id: req.params.id,
@@ -67,6 +74,9 @@ export class ExercisesController extends BaseController {
     );
   };
 
+  @SwaggerPost()
+  @SwaggerResponse(ExerciseSerialization)
+  @SwaggerRequest(createExerciseSchema)
   create = async (req: Request, res: Response) => {
     const data = await this.exercisesService.create(req.body);
     return JsonResponse.success(
@@ -77,6 +87,9 @@ export class ExercisesController extends BaseController {
     );
   };
 
+  @SwaggerPatch("/:id")
+  @SwaggerRequest(updateExerciseSchema)
+  @SwaggerResponse(ExerciseSerialization)
   update = async (req: Request, res: Response) => {
     const data = await this.exercisesService.updateOne(
       { _id: req.params.id },
@@ -90,6 +103,8 @@ export class ExercisesController extends BaseController {
     );
   };
 
+  @SwaggerDelete("/:id")
+  @SwaggerResponse({})
   delete = async (req: Request, res: Response) => {
     await this.exercisesService.deleteOne({ _id: req.params.id });
     return JsonResponse.success({}, res);

src/modules/console/modules/muscles/controllers/muscles.controller.ts

@@ -4,7 +4,7 @@ import { parsePaginationQuery } from "@helpers/pagination";
 import { asyncHandler } from "@helpers/async-handler";
 import { paramsValidator, bodyValidator } from "@helpers/validation.helper";
 import { BaseController } from "@lib/controllers/controller.base";
-import { Prefix } from "@lib/decorators/prefix.decorator";
+import { Controller } from "@lib/decorators/prefix.decorator";
 import { serialize } from "@helpers/serialize";
 import { ControllerMiddleware } from "@lib/decorators/controller-middleware.decorator";
 import { AdminGuardMiddleware } from "modules/console/common/guards/admins.guard";
@@ -12,8 +12,11 @@ import { MusclesService } from "../services/muscles.service";
 import { createMusclechema } from "../validations/create-muscle.validation";
 import { updateMuscleSchema } from "../validations/update-muscle.validation";
 import { MuscleSerialization } from "@common/serializers/equipment.serialization";
+import { SwaggerRequest } from "@lib/decorators/swagger-request.decorator";
+import { SwaggerResponse } from "@lib/decorators/swagger-response.decorator";
+import { SwaggerGet, SwaggerPost, SwaggerPatch, SwaggerDelete } from "@lib/decorators/swagger-routes.decorator";
 
-@Prefix("/console/muscles")
+@Controller("/console/muscles")
 @ControllerMiddleware(AdminGuardMiddleware({}))
 export class MusclesController extends BaseController {
     private musclesService = new MusclesService();
@@ -37,6 +40,8 @@ export class MusclesController extends BaseController {
         );
     }
 
+    @SwaggerGet()
+    @SwaggerResponse([MuscleSerialization])
     list = async (req: Request, res: Response) => {
         const paginationQuery = parsePaginationQuery(req.query);
         const { docs, paginationData } = await this.musclesService.list(
@@ -53,6 +58,8 @@ export class MusclesController extends BaseController {
         );
     };
 
+    @SwaggerGet('/:id')
+    @SwaggerResponse(MuscleSerialization)
     get = async (req: Request, res: Response) => {
         const data = await this.musclesService.findOneOrFail({
             _id: req.params.id,
@@ -65,6 +72,9 @@ export class MusclesController extends BaseController {
         );
     };
 
+    @SwaggerPost()
+    @SwaggerRequest(createMusclechema)
+    @SwaggerResponse(MuscleSerialization)
     create = async (req: Request, res: Response) => {
         const data = await this.musclesService.create(req.body);
         return JsonResponse.success(
@@ -76,6 +86,9 @@ export class MusclesController extends BaseController {
         );
     };
 
+    @SwaggerPatch('/:id')
+    @SwaggerRequest(updateMuscleSchema)
+    @SwaggerResponse(MuscleSerialization)
     update = async (req: Request, res: Response) => {
         const data = await this.musclesService.updateOne(
             { _id: req.params.id },
@@ -89,6 +102,8 @@ export class MusclesController extends BaseController {
         );
     };
 
+    @SwaggerDelete('/:id')
+    @SwaggerResponse(MuscleSerialization)
     delete = async (req: Request, res: Response) => {
         const data = await this.musclesService.deleteOne({ _id: req.params.id });
         return JsonResponse.success(

src/modules/console/modules/users/controllers/users.controller.ts

@@ -3,11 +3,13 @@ import { JsonResponse } from "@lib/responses/json-response";
 import { Request, Response } from "express";
 import { asyncHandler } from "@helpers/async-handler";
 import { BaseController } from "@lib/controllers/controller.base";
-import { Prefix } from "@lib/decorators/prefix.decorator";
+import { Controller } from "@lib/decorators/prefix.decorator";
 import { serialize } from "@helpers/serialize";
 import { UserSerialization } from "@common/serializers/user.serialization";
+import { SwaggerPost } from "@lib/decorators/swagger-routes.decorator";
+import { SwaggerResponse } from "@lib/decorators/swagger-response.decorator";
 
-@Prefix("/console/users")
+@Controller("/console/users")
 export class AdminUsersController extends BaseController {
   private usersService: UsersService = new UsersService();
 
@@ -15,6 +17,8 @@ export class AdminUsersController extends BaseController {
     this.router.post("/create", asyncHandler(this.create));
   }
 
+  @SwaggerPost("/create")
+  @SwaggerResponse(UserSerialization)
   create = async (req: Request, res: Response): Promise<Response> => {
     let user = await this.usersService.create(req.body);
 

src/modules/console/modules/workouts/controllers/workouts.controller.ts

@@ -7,95 +7,117 @@ import { paramsValidator, bodyValidator } from "@helpers/validation.helper";
 import { createWorkoutSchema } from "../validations/create-workout.validation";
 import { updateWorkoutSchema } from "../validations/update-workout.validation";
 import { BaseController } from "@lib/controllers/controller.base";
-import { Prefix } from "@lib/decorators/prefix.decorator";
+import { Controller } from "@lib/decorators/prefix.decorator";
 import { serialize } from "@helpers/serialize";
 import { WorkoutSerialization } from "@common/serializers/workout.serialization";
 import { ControllerMiddleware } from "@lib/decorators/controller-middleware.decorator";
 import { AdminGuardMiddleware } from "modules/console/common/guards/admins.guard";
+import {
+  SwaggerDelete,
+  SwaggerGet,
+  SwaggerPatch,
+  SwaggerPost,
+} from "@lib/decorators/swagger-routes.decorator";
+import { SwaggerResponse } from "@lib/decorators/swagger-response.decorator";
+import { SwaggerRequest } from "@lib/decorators/swagger-request.decorator";
 
-@Prefix("/console/workouts")
+@Controller("/console/workouts")
 @ControllerMiddleware(AdminGuardMiddleware({}))
 export class WorkoutController extends BaseController {
-    private workoutsService = new WorkoutService();
+  private workoutsService = new WorkoutService();
 
-    setRoutes() {
-        this.router.get("/", asyncHandler(this.list));
-        this.router.get("/:id", paramsValidator("id"), asyncHandler(this.get));
-        this.router.post("/",
-            bodyValidator(createWorkoutSchema),
-            asyncHandler(this.create));
-        this.router.patch(
-            "/:id",
-            paramsValidator("id"),
-            bodyValidator(updateWorkoutSchema),
-            asyncHandler(this.update)
-        );
-        this.router.delete(
-            "/:id",
-            paramsValidator("id"),
-            asyncHandler(this.delete)
-        );
-    }
+  setRoutes() {
+    this.router.get("/", asyncHandler(this.list));
+    this.router.get("/:id", paramsValidator("id"), asyncHandler(this.get));
+    this.router.post(
+      "/",
+      bodyValidator(createWorkoutSchema),
+      asyncHandler(this.create)
+    );
+    this.router.patch(
+      "/:id",
+      paramsValidator("id"),
+      bodyValidator(updateWorkoutSchema),
+      asyncHandler(this.update)
+    );
+    this.router.delete(
+      "/:id",
+      paramsValidator("id"),
+      asyncHandler(this.delete)
+    );
+  }
 
-    list = async (req: Request, res: Response) => {
-        const paginationQuery = parsePaginationQuery(req.query);
-        const { docs, paginationData } = await this.workoutsService.list(
-            {},
-            paginationQuery
-        );
+  @SwaggerGet()
+  @SwaggerResponse([WorkoutSerialization])
+  list = async (req: Request, res: Response) => {
+    const paginationQuery = parsePaginationQuery(req.query);
+    const { docs, paginationData } = await this.workoutsService.list(
+      {},
+      paginationQuery
+    );
 
-        return JsonResponse.success(
-            {
-                data: serialize(docs, WorkoutSerialization),
-                meta: paginationData,
-            },
-            res
-        );
-    };
+    return JsonResponse.success(
+      {
+        data: serialize(docs, WorkoutSerialization),
+        meta: paginationData,
+      },
+      res
+    );
+  };
 
-    get = async (req: Request, res: Response) => {
-        const data = await this.workoutsService.findOneOrFail({
-            _id: req.params.id,
-        });
-        return JsonResponse.success(
-            {
-                data: serialize(data.toJSON(), WorkoutSerialization),
-            },
-            res
-        );
-    };
+  @SwaggerGet("/:id")
+  @SwaggerResponse(WorkoutSerialization)
+  get = async (req: Request, res: Response) => {
+    const data = await this.workoutsService.findOneOrFail({
+      _id: req.params.id,
+    });
+    return JsonResponse.success(
+      {
+        data: serialize(data.toJSON(), WorkoutSerialization),
+      },
+      res
+    );
+  };
 
-    create = async (req: Request, res: Response) => {
-        const data = await this.workoutsService.create(req.body);
-        return JsonResponse.success(
-            {
-                status: 201,
-                data: serialize(data.toJSON(), WorkoutSerialization),
-            },
-            res
-        );
-    };
+  @SwaggerPost()
+  @SwaggerResponse(WorkoutSerialization)
+  @SwaggerRequest(createWorkoutSchema)
+  create = async (req: Request, res: Response) => {
+    const data = await this.workoutsService.create(req.body);
+    return JsonResponse.success(
+      {
+        status: 201,
+        data: serialize(data.toJSON(), WorkoutSerialization),
+      },
+      res
+    );
+  };
 
-    update = async (req: Request, res: Response) => {
-        const data = await this.workoutsService.updateOne(
-            { _id: req.params.id },
-            req.body
-        );
-        return JsonResponse.success(
-            {
-                data: serialize(data.toJSON(), WorkoutSerialization),
-            },
-            res
-        );
-    };
+  @SwaggerPatch("/:id")
+  @SwaggerResponse(WorkoutSerialization)
+  @SwaggerRequest(updateWorkoutSchema)
+  update = async (req: Request, res: Response) => {
+    const data = await this.workoutsService.updateOne(
+      { _id: req.params.id },
+      req.body
+    );
+    return JsonResponse.success(
+      {
+        data: serialize(data.toJSON(), WorkoutSerialization),
+      },
+      res
+    );
+  };
 
-    delete = async (req: Request, res: Response) => {
-        const data = await this.workoutsService.deleteOne({ _id: req.params.id });
-        return JsonResponse.success(
-            {
-                data: serialize(data.toJSON(), WorkoutSerialization),
-            },
-            res
-        );
-    };
-};
+  @SwaggerDelete("/:id")
+  @SwaggerResponse(WorkoutSerialization)
+  delete = async (req: Request, res: Response) => {
+    const data = await this.workoutsService.deleteOne({ _id: req.params.id });
+    return JsonResponse.success(
+      {
+        data: serialize(data.toJSON(), WorkoutSerialization),
+      },
+      res
+    );
+  };
+}

src/modules/users/modules/auth/controllers/auth.controller.ts

@@ -8,12 +8,15 @@ import {
 import { asyncHandler } from "@helpers/async-handler";
 import { bodyValidator } from "@helpers/validation.helper";
 import { BaseController } from "@lib/controllers/controller.base";
-import { Prefix } from "@lib/decorators/prefix.decorator";
+import { Controller } from "@lib/decorators/prefix.decorator";
 import { serialize } from "@helpers/serialize";
 import { UserSerialization } from "@common/serializers/user.serialization";
 import { UsersAuthService } from "../services/users-auth.service";
+import { SwaggerPost } from "@lib/decorators/swagger-routes.decorator";
+import { SwaggerRequest } from "@lib/decorators/swagger-request.decorator";
+import { SwaggerResponse } from "@lib/decorators/swagger-response.decorator";
 
-@Prefix("/user/auth")
+@Controller("/user/auth")
 export class UsersAuthController extends BaseController {
   private authService = new UsersAuthService();
 
@@ -30,6 +33,9 @@ export class UsersAuthController extends BaseController {
     );
   }
 
+  @SwaggerPost("/register")
+  @SwaggerRequest(userRegisterSchema)
+  @SwaggerResponse(UserSerialization)
   register = async (req: Request, res: Response) => {
     const user = await this.authService.register(req.body as IUserRegister);
 
@@ -41,6 +47,9 @@ export class UsersAuthController extends BaseController {
     );
   };
 
+  @SwaggerPost("/login")
+  @SwaggerRequest(loginValidationSchema)
+  @SwaggerResponse(UserSerialization)
   login = async (req: Request, res: Response): Promise<Response> => {
     const { user, token } = await this.authService.login(req.body);
 

src/modules/users/modules/exercises/controllers/exercises.controller.ts

@@ -5,13 +5,15 @@ import { parsePaginationQuery } from "@helpers/pagination";
 import { asyncHandler } from "@helpers/async-handler";
 import { paramsValidator } from "@helpers/validation.helper";
 import { BaseController } from "@lib/controllers/controller.base";
-import { Prefix } from "@lib/decorators/prefix.decorator";
+import { Controller } from "@lib/decorators/prefix.decorator";
 import { serialize } from "@helpers/serialize";
 import { ExerciseSerialization } from "@common/serializers/exercise.serialization";
 import { ControllerMiddleware } from "@lib/decorators/controller-middleware.decorator";
 import { UsersGuardMiddleware } from "modules/users/common/guards/users.guard";
+import { SwaggerGet } from "@lib/decorators/swagger-routes.decorator";
+import { SwaggerResponse } from "@lib/decorators/swagger-response.decorator";
 
-@Prefix("/user/exercises")
+@Controller("/user/exercises")
 @ControllerMiddleware(UsersGuardMiddleware())
 export class ExerciseController extends BaseController {
   private exercisesService = new ExerciseService();
@@ -21,6 +23,8 @@ export class ExerciseController extends BaseController {
     this.router.get("/:id", paramsValidator("id"), asyncHandler(this.get));
   }
 
+  @SwaggerGet()
+  @SwaggerResponse([ExerciseSerialization])
   list = async (req: Request, res: Response): Promise<Response> => {
     const paginationQuery = parsePaginationQuery(req.query);
     const { docs, paginationData } = await this.exercisesService.list(
@@ -37,6 +41,8 @@ export class ExerciseController extends BaseController {
     );
   };
 
+  @SwaggerGet("/:id")
+  @SwaggerResponse(ExerciseSerialization)
   get = async (req: Request, res: Response): Promise<Response> => {
     const data = await this.exercisesService.findOneOrFail({
       _id: req.params.id,

src/modules/users/modules/user-registered-workouts/controllers/user-registered-workouts.controller.ts

@@ -5,19 +5,25 @@ import { parsePaginationQuery } from "@helpers/pagination";
 import { paramsValidator, bodyValidator } from "@helpers/validation.helper";
 import { asyncHandler } from "@helpers/async-handler";
 import { BaseController } from "@lib/controllers/controller.base";
-import { Prefix } from "@lib/decorators/prefix.decorator";
+import { Controller } from "@lib/decorators/prefix.decorator";
 import { serialize } from "@helpers/serialize";
 import { UserRegisteredWorkoutsSerialization } from "@common/serializers/user-registered-workout.serialization";
 import { ControllerMiddleware } from "@lib/decorators/controller-middleware.decorator";
 import { UsersGuardMiddleware } from "modules/users/common/guards/users.guard";
 import { createUserRegisteredWorkoutsSchema } from "../validations/create-user-registered-workouts.validation";
 import { updateUserRegisteredWorkoutsSchema } from "../validations/update-user-registered-workouts.validation";
+import {
+  SwaggerGet,
+  SwaggerPost,
+} from "@lib/decorators/swagger-routes.decorator";
+import { SwaggerResponse } from "@lib/decorators/swagger-response.decorator";
+import { SwaggerRequest } from "@lib/decorators/swagger-request.decorator";
 
 interface userRequest extends Request {
   jwtPayload?: any;
 }
 
-@Prefix("/user/myWorkouts")
+@Controller("/user/myWorkouts")
 @ControllerMiddleware(UsersGuardMiddleware())
 export class userRegisteredWorkoutsController extends BaseController {
   private userRegisteredWorkoutsService = new UserRegisteredWorkoutsService();
@@ -25,23 +31,28 @@ export class userRegisteredWorkoutsController extends BaseController {
   setRoutes(): void {
     this.router.get("/:id", paramsValidator("id"), asyncHandler(this.get));
     this.router.get("/", asyncHandler(this.list));
-    this.router.post("/",
+    this.router.post(
+      "/",
       bodyValidator(createUserRegisteredWorkoutsSchema),
-      asyncHandler(this.create));
+      asyncHandler(this.create)
+    );
   }
 
+  @SwaggerGet()
+  @SwaggerResponse([UserRegisteredWorkoutsSerialization])
   list = async (req: userRequest, res: Response) => {
     const paginationQuery = parsePaginationQuery(req.query);
-    const { docs, paginationData } = await this.userRegisteredWorkoutsService.list(
-      { user: req.jwtPayload.id },
-      paginationQuery,
-      {
-        populateArray: [
-          { path: "workout", select: "-templateWeeks -created_by" },
-          { path: "weeks.days.exercises", select: "name media reps sets" },
-        ]
-      }
-    );
+    const { docs, paginationData } =
+      await this.userRegisteredWorkoutsService.list(
+        { user: req.jwtPayload.id },
+        paginationQuery,
+        {
+          populateArray: [
+            { path: "workout", select: "-templateWeeks -created_by" },
+            { path: "weeks.days.exercises", select: "name media reps sets" },
+          ],
+        }
+      );
 
     return JsonResponse.success(
       {
@@ -52,6 +63,8 @@ export class userRegisteredWorkoutsController extends BaseController {
     );
   };
 
+  @SwaggerGet("/:id")
+  @SwaggerResponse(UserRegisteredWorkoutsSerialization)
   get = async (req: userRequest, res: Response) => {
     const data = await this.userRegisteredWorkoutsService.findOneOrFail(
       { _id: req.params.id },
@@ -59,7 +72,7 @@ export class userRegisteredWorkoutsController extends BaseController {
         populateArray: [
           { path: "workout", select: "-template_weeks -created_by" },
           { path: "weeks.days.exercises", select: "name media reps sets" },
-        ]
+        ],
       }
     );
     return JsonResponse.success(
@@ -70,6 +83,9 @@ export class userRegisteredWorkoutsController extends BaseController {
     );
   };
 
+  @SwaggerPost()
+  @SwaggerResponse(UserRegisteredWorkoutsSerialization)
+  @SwaggerRequest(createUserRegisteredWorkoutsSchema)
   create = async (req: userRequest, res: Response) => {
     const data = await this.userRegisteredWorkoutsService.create(req.body);
     return JsonResponse.success(
@@ -80,5 +96,4 @@ export class userRegisteredWorkoutsController extends BaseController {
       res
     );
   };
-
 }

src/modules/users/modules/workouts/controllers/workouts.controller.ts

@@ -5,13 +5,15 @@ import { parsePaginationQuery } from "@helpers/pagination";
 import { asyncHandler } from "@helpers/async-handler";
 import { paramsValidator } from "@helpers/validation.helper";
 import { BaseController } from "@lib/controllers/controller.base";
-import { Prefix } from "@lib/decorators/prefix.decorator";
+import { Controller } from "@lib/decorators/prefix.decorator";
 import { serialize } from "@helpers/serialize";
 import { WorkoutSerialization } from "@common/serializers/workout.serialization";
 import { ControllerMiddleware } from "@lib/decorators/controller-middleware.decorator";
 import { UsersGuardMiddleware } from "modules/users/common/guards/users.guard";
+import { SwaggerGet } from "@lib/decorators/swagger-routes.decorator";
+import { SwaggerResponse } from "@lib/decorators/swagger-response.decorator";
 
-@Prefix("/user/workouts")
+@Controller("/user/workouts")
 @ControllerMiddleware(UsersGuardMiddleware())
 export class WorkoutController extends BaseController {
   private workoutsService = new WorkoutService();
@@ -21,6 +23,8 @@ export class WorkoutController extends BaseController {
     this.router.get("/:id", paramsValidator("id"), asyncHandler(this.get));
   }
 
+  @SwaggerGet()
+  @SwaggerResponse([WorkoutSerialization])
   list = async (req: Request, res: Response): Promise<Response> => {
     const paginationQuery = parsePaginationQuery(req.query);
     const { docs, paginationData } = await this.workoutsService.list(
@@ -37,6 +41,8 @@ export class WorkoutController extends BaseController {
     );
   };
 
+  @SwaggerGet("/:id")
+  @SwaggerResponse(WorkoutSerialization)
   get = async (req: Request, res: Response): Promise<Response> => {
     const data = await this.workoutsService.findOneOrFail({
       _id: req.params.id,

src/routes.ts

@@ -2,11 +2,12 @@ import { Router, Express } from "express";
 
 import * as glob from "glob";
 import path from "path";
-import { TspecDocsMiddleware } from "tspec";
+import swaggerUi from "swagger-ui-express";
 import { BaseController } from "./lib/controllers/controller.base";
 import { validationErrorHandler } from "./helpers/validation.helper";
 import { JsonResponse } from "@lib/responses/json-response";
 import { errorHandlerMiddleware } from "middlewares/error-handler.middleware";
+import { swaggerRegistry } from "@lib/swagger/swagger";
 
 /**
  * Sets the routes for the Express app.
@@ -45,23 +46,14 @@ const setCustomRoutes = async (router: Router) => {
   router.use(validationErrorHandler);
 
   // docs
-  router.use("/docs", await TspecDocsMiddleware({
-    openapi: {
-      title: 'API Documentation',
-      version: '0.0.1',
-      securityDefinitions: {
-        jwt: {
-          type: 'http',
-          scheme: 'bearer',
-          bearerFormat: 'JWT',
-        }
-      }
-    }
-  }));
+  router.use(
+    "/docs",
+    swaggerUi.serve,
+    swaggerUi.setup(swaggerRegistry.generateSwaggerDocument())
+  );
 
   // Invalid URL handler
   router.all("*", (req: any, res: any) => {
-
     JsonResponse.error(
       {
         error: "Invalid URL!",

tsconfig.json

@@ -1,5 +1,5 @@
 {
-  "include": ["src/**/*"],
+  "include": ["src/**/*.ts"],
   "compilerOptions": {
     "module": "commonjs",
     "esModuleInterop": true,