Merge pull request #62 from Modarb-Ai-Trainer/docs

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

@@ -0,0 +1,56 @@
+import { swaggerRegistry } from "@lib/swagger/swagger";
+import { getCallingFileName } from "@lib/utils/calling-file.helper";
+
+type QueryType = "string" | "number" | "boolean";
+
+export const SwaggerQuery = (
+  querySchema: Record<
+    string,
+    | {
+        type: QueryType | (string | number | boolean)[];
+        required?: boolean;
+      }
+    | QueryType
+    | (string | number | boolean)[]
+  >
+) => {
+  return (target: any, propertyKey: string) => {
+    const queryParams = Object.entries(querySchema).map(([key, type]) => {
+      let schema;
+
+      if (Array.isArray(type)) {
+        schema = {
+          type: "string",
+          enum: type,
+        };
+      } else if (typeof type === "string") {
+        schema = {
+          type,
+        };
+      } else {
+        schema = Array.isArray(type["type"])
+          ? {
+              type: "string",
+              enum: type["type"],
+            }
+          : {
+              type: type.type,
+            };
+      }
+
+      return {
+        name: key,
+        in: "query",
+        required: type["required"] || false,
+        schema,
+      };
+    });
+
+    target.constructor["targetName"] =
+      target.constructor.name + getCallingFileName();
+    swaggerRegistry.updateRoute(target.constructor["targetName"], {
+      propertyKey,
+      queryParams,
+    });
+  };
+};

src/lib/swagger/swagger.ts

@@ -13,7 +13,7 @@ class SwaggerRegistry {
         method?: "get" | "post" | "put" | "patch" | "delete";
         request?: any;
         response?: any;
-        query?: any;
+        queryParams?: any;
         description?: string;
         summary?: string;
         tags?: string[];
@@ -81,7 +81,7 @@ class SwaggerRegistry {
       method?: "get" | "post" | "put" | "patch" | "delete";
       request?: any;
       response?: any;
-      query?: any;
+      queryParams?: any;
       description?: string;
       summary?: string;
       tags?: string[];
@@ -121,6 +121,7 @@ class SwaggerRegistry {
 
       controllerData.routes.forEach((route) => {
         route.path = `/api/v1${controllerData.prefix}${route.path}`;
+        const params = route.path.match(/:(\w+)/g);
 
         if (!paths[route.path]) {
           paths[route.path] = {};
@@ -135,6 +136,21 @@ class SwaggerRegistry {
           tags: [...(controllerData.tags || []), ...(route.tags || [])],
           summary: route.summary,
           description: route.description,
+          parameters: [
+            ...((params &&
+              params.map((param) => {
+                return {
+                  name: param.replace(":", ""),
+                  in: "path",
+                  required: true,
+                  schema: {
+                    type: "string",
+                  },
+                };
+              })) ||
+              []),
+            ...(route.queryParams || []),
+          ],
           responses: {
             200: {
               description: "Success",

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

@@ -26,6 +26,7 @@ import { SwaggerResponse } from "@lib/decorators/swagger-response.decorator";
 import { SwaggerRequest } from "@lib/decorators/swagger-request.decorator";
 import { SwaggerSummary } from "@lib/decorators/swagger-summary.decorator";
 import { SwaggerDescription } from "@lib/decorators/swagger-description.decorator";
+import { SwaggerQuery } from "@lib/decorators/swagger-query.decorator";
 
 @Controller("/console/admins")
 @ControllerMiddleware(AdminGuardMiddleware({ roles: [Role.SUPER_ADMIN] }))