feat: add swagger summary and description

src/lib/decorators/{prefix.decorator.ts → controller.decorator.ts}

@@ -2,7 +2,13 @@ import { swaggerRegistry } from "@lib/swagger/swagger";
 import { BaseController } from "../controllers/controller.base";
 import { getCallingFileName } from "@lib/utils/calling-file.helper";
 
-export const Controller = (prefix: string) => {
+export const Controller = (
+  prefix: string,
+  options: { autoTag?: boolean } = {}
+) => {
+  // default options
+  const { autoTag = true } = options;
+
   return (target: typeof BaseController) => {
     const originalConstructor = target;
     const newConstructor: any = function (...args: any[]) {
@@ -12,18 +18,25 @@ export const Controller = (prefix: string) => {
     };
     newConstructor.prototype = originalConstructor.prototype;
 
-    target.prototype.constructor['targetName'] = target.prototype.constructor.name + getCallingFileName();
+    target.prototype.constructor["targetName"] =
+      target.prototype.constructor.name + getCallingFileName();
     swaggerRegistry.setControllerPrefix(
-      target.prototype.constructor['targetName'],
+      target.prototype.constructor["targetName"],
       prefix
     );
-    swaggerRegistry.setControllerTags(target.prototype.constructor['targetName'], [
-      prefix
-        .split("/")
-        .slice(1)
-        .map((tag) => tag.charAt(0).toUpperCase() + tag.slice(1))
-        .join(" - "),
-    ]);
+
+    if (autoTag) {
+      swaggerRegistry.setControllerTags(
+        target.prototype.constructor["targetName"],
+        [
+          prefix
+            .split("/")
+            .slice(1)
+            .map((tag) => tag.charAt(0).toUpperCase() + tag.slice(1))
+            .join(" - "),
+        ]
+      );
+    }
     return newConstructor;
   };
 };

src/lib/decorators/{swagger-tags.decorator.ts → swagger-controller-tags.decorator.ts}

@@ -1,11 +1,10 @@
 import { swaggerRegistry } from "@lib/swagger/swagger";
 import { getCallingFileName } from "@lib/utils/calling-file.helper";
 
-export const SwaggerTags = (...tags: string[]) => {
+export const SwaggerControllerTags = (...tags: string[]) => {
   if (!tags.length) return;
   return (target: any) => {
     target.constructor['targetName'] = target.prototype.constructor.name = getCallingFileName();
-    target = target.prototype.constructor.name + getCallingFileName();
-    swaggerRegistry.setControllerTags(target, tags);
+    swaggerRegistry.setControllerTags(target.constructor['targetName'], tags);
   };
 };

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

@@ -0,0 +1,12 @@
+import { swaggerRegistry } from "@lib/swagger/swagger";
+import { getCallingFileName } from "@lib/utils/calling-file.helper";
+
+export const SwaggerDescription = (description: string) => {
+  return (target: any, propertyKey: string) => {
+    target.constructor['targetName'] = target.constructor.name + getCallingFileName()
+    swaggerRegistry.updateRoute(target.constructor.name + getCallingFileName(), {
+      propertyKey,
+      description,
+    });
+  };
+};

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

@@ -0,0 +1,13 @@
+import { swaggerRegistry } from "@lib/swagger/swagger";
+import { getCallingFileName } from "@lib/utils/calling-file.helper";
+
+export const SwaggerEndpointTags = (...tags: string[]) => {
+  if (!tags.length) return;
+  return (target: any, propertyKey: string) => {
+    target.constructor['targetName'] = target.constructor.name + getCallingFileName()
+    swaggerRegistry.updateRoute(target.constructor.name + getCallingFileName(), {
+      propertyKey,
+      tags,
+    });
+  };
+};

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

@@ -7,7 +7,7 @@ export const SwaggerRoute = (
 ) => {
   return (target: any, propertyKey: string) => {
     target.constructor['targetName'] = target.constructor.name + getCallingFileName()
-    swaggerRegistry.updateRoute(target.constructor.name + getCallingFileName(), {
+    swaggerRegistry.updateRoute(target.constructor['targetName'], {
       propertyKey,
       path,
       method,

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

@@ -0,0 +1,12 @@
+import { swaggerRegistry } from "@lib/swagger/swagger";
+import { getCallingFileName } from "@lib/utils/calling-file.helper";
+
+export const SwaggerSummary = (summary: string) => {
+  return (target: any, propertyKey: string) => {
+    target.constructor['targetName'] = target.constructor.name + getCallingFileName()
+    swaggerRegistry.updateRoute(target.constructor.name + getCallingFileName(), {
+      propertyKey,
+      summary,
+    });
+  };
+};

src/lib/swagger/swagger.ts

@@ -13,6 +13,10 @@ class SwaggerRegistry {
         method?: "get" | "post" | "put" | "patch" | "delete";
         request?: any;
         response?: any;
+        query?: any;
+        description?: string;
+        summary?: string;
+        tags?: string[];
       }[];
       prefix: string;
       tags?: string[];
@@ -77,6 +81,10 @@ class SwaggerRegistry {
       method?: "get" | "post" | "put" | "patch" | "delete";
       request?: any;
       response?: any;
+      query?: any;
+      description?: string;
+      summary?: string;
+      tags?: string[];
     }
   ) {
     this.initControllerIfNotExists(controller);
@@ -124,7 +132,9 @@ class SwaggerRegistry {
               bearerAuth: [],
             },
           ],
-          tags: controllerData.tags,
+          tags: [...(controllerData.tags || []), ...(route.tags || [])],
+          summary: route.summary,
+          description: route.description,
           responses: {
             200: {
               description: "Success",
@@ -146,22 +156,6 @@ class SwaggerRegistry {
             },
           };
         }
-
-        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 = [];
-        }
       });
     });
 

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

@@ -1,7 +1,7 @@
 import { asyncHandler } from "@helpers/async-handler";
 import { paramsValidator, bodyValidator } from "@helpers/validation.helper";
 import { BaseController } from "@lib/controllers/controller.base";
-import { Controller } from "@lib/decorators/prefix.decorator";
+import { Controller } from "@lib/decorators/controller.decorator";
 import { Request, Response } from "express";
 import { AdminsService } from "../services/admins.service";
 import {
@@ -24,6 +24,8 @@ import {
 } from "@lib/decorators/swagger-routes.decorator";
 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";
 
 @Controller("/console/admins")
 @ControllerMiddleware(AdminGuardMiddleware({ roles: [Role.SUPER_ADMIN] }))
@@ -53,6 +55,8 @@ export class AdminsController extends BaseController {
 
   @SwaggerGet()
   @SwaggerResponse([AdminSerialization])
+  @SwaggerSummary("List all admins")
+  @SwaggerDescription("List all admins")
   list = async (
     req: Request,
     res: Response<IJSONSuccessResponse<AdminSerialization[]>>
@@ -74,6 +78,8 @@ export class AdminsController extends BaseController {
 
   @SwaggerGet("/:id")
   @SwaggerResponse(AdminSerialization)
+  @SwaggerSummary("Get admin by id")
+  @SwaggerDescription("Get admin by id")
   get = async (
     req: Request<{ id: string }>,
     res: Response<IJSONSuccessResponse<AdminSerialization>>
@@ -93,6 +99,8 @@ export class AdminsController extends BaseController {
   @SwaggerPost()
   @SwaggerResponse(AdminSerialization)
   @SwaggerRequest(createAdminSchema)
+  @SwaggerSummary("Create new admin")
+  @SwaggerDescription("Creates a new admin with role of admin")
   create = async (
     req: Request<{}, {}, ICreateAdmin>,
     res: Response<IJSONSuccessResponse<AdminSerialization>>
@@ -111,6 +119,8 @@ export class AdminsController extends BaseController {
   @SwaggerPatch("/:id")
   @SwaggerResponse(AdminSerialization)
   @SwaggerRequest(createAdminSchema)
+  @SwaggerSummary("Update admin")
+  @SwaggerDescription("Updates an admin")
   update = async (
     req: Request<{ id: string }, {}, ICreateAdmin>,
     res: Response<IJSONSuccessResponse<AdminSerialization>>
@@ -132,6 +142,8 @@ export class AdminsController extends BaseController {
 
   @SwaggerDelete("/:id")
   @SwaggerResponse(AdminSerialization)
+  @SwaggerSummary("Delete admin")
+  @SwaggerDescription("Deletes an admin")
   delete = async (
     req: Request<{ id: string }>,
     res: Response<IJSONSuccessResponse<AdminSerialization>>

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

@@ -2,7 +2,7 @@ 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 { Controller } from "@lib/decorators/prefix.decorator";
+import { Controller } from "@lib/decorators/controller.decorator";
 import { JsonResponse } from "@lib/responses/json-response";
 import { Request, Response } from "express";
 import { loginValidationSchema } from "modules/users/modules/auth/validation/login.validation";

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 { Controller } from "@lib/decorators/prefix.decorator";
+import { Controller } from "@lib/decorators/controller.decorator";
 import { serialize } from "@helpers/serialize";
 import { ControllerMiddleware } from "@lib/decorators/controller-middleware.decorator";
 import { AdminGuardMiddleware } from "modules/console/common/guards/admins.guard";

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 { Controller } from "@lib/decorators/prefix.decorator";
+import { Controller } from "@lib/decorators/controller.decorator";
 import { JsonResponse } from "@lib/responses/json-response";
 import { AdminGuardMiddleware } from "modules/console/common/guards/admins.guard";
 import { ExercisesService } from "../services/exercises.service";

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 { Controller } from "@lib/decorators/prefix.decorator";
+import { Controller } from "@lib/decorators/controller.decorator";
 import { serialize } from "@helpers/serialize";
 import { ControllerMiddleware } from "@lib/decorators/controller-middleware.decorator";
 import { AdminGuardMiddleware } from "modules/console/common/guards/admins.guard";

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

@@ -3,7 +3,7 @@ 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 { Controller } from "@lib/decorators/prefix.decorator";
+import { Controller } from "@lib/decorators/controller.decorator";
 import { serialize } from "@helpers/serialize";
 import { UserSerialization } from "@common/serializers/user.serialization";
 import { SwaggerPost } from "@lib/decorators/swagger-routes.decorator";

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

@@ -7,7 +7,7 @@ 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 { Controller } from "@lib/decorators/prefix.decorator";
+import { Controller } from "@lib/decorators/controller.decorator";
 import { serialize } from "@helpers/serialize";
 import { WorkoutSerialization } from "@common/serializers/workout.serialization";
 import { ControllerMiddleware } from "@lib/decorators/controller-middleware.decorator";

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

@@ -8,7 +8,7 @@ import {
 import { asyncHandler } from "@helpers/async-handler";
 import { bodyValidator } from "@helpers/validation.helper";
 import { BaseController } from "@lib/controllers/controller.base";
-import { Controller } from "@lib/decorators/prefix.decorator";
+import { Controller } from "@lib/decorators/controller.decorator";
 import { serialize } from "@helpers/serialize";
 import { UserSerialization } from "@common/serializers/user.serialization";
 import { UsersAuthService } from "../services/users-auth.service";

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

@@ -5,7 +5,7 @@ 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 { Controller } from "@lib/decorators/prefix.decorator";
+import { Controller } from "@lib/decorators/controller.decorator";
 import { serialize } from "@helpers/serialize";
 import { ExerciseSerialization } from "@common/serializers/exercise.serialization";
 import { ControllerMiddleware } from "@lib/decorators/controller-middleware.decorator";

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

@@ -5,7 +5,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 { Controller } from "@lib/decorators/prefix.decorator";
+import { Controller } from "@lib/decorators/controller.decorator";
 import { serialize } from "@helpers/serialize";
 import { TemplateSerialization } from "@common/serializers/template.serialization";
 import { ControllerMiddleware } from "@lib/decorators/controller-middleware.decorator";

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

@@ -5,7 +5,7 @@ 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 { Controller } from "@lib/decorators/prefix.decorator";
+import { Controller } from "@lib/decorators/controller.decorator";
 import { serialize } from "@helpers/serialize";
 import { UserRegisteredWorkoutsSerialization } from "@common/serializers/user-registered-workout.serialization";
 import { ControllerMiddleware } from "@lib/decorators/controller-middleware.decorator";

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

@@ -5,7 +5,7 @@ import { updateUserSchema } from "../validation/update.validation";
 import { paramsValidator, bodyValidator } from "@helpers/validation.helper";
 import { asyncHandler } from "@helpers/async-handler";
 import { BaseController } from "@lib/controllers/controller.base";
-import { Controller } from "@lib/decorators/prefix.decorator";
+import { Controller } from "@lib/decorators/controller.decorator";
 import { serialize } from "@helpers/serialize";
 import { UserSerialization } from "@common/serializers/user.serialization";
 import { ControllerMiddleware } from "@lib/decorators/controller-middleware.decorator";

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

@@ -5,7 +5,7 @@ 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 { Controller } from "@lib/decorators/prefix.decorator";
+import { Controller } from "@lib/decorators/controller.decorator";
 import { serialize } from "@helpers/serialize";
 import { WorkoutSerialization } from "@common/serializers/workout.serialization";
 import { ControllerMiddleware } from "@lib/decorators/controller-middleware.decorator";