removed unwanted props from swagger

Signed-off-by: Tanmay Vaij <tanmayvaij22@gmail.com>

src/app.ts

@@ -6,9 +6,7 @@ import { rootRouter } from "./routers";
 import { connectToDatabase } from "./database";
 
 import { checkEnvVariables } from "./utils/checkEnvVariables";
-
-import swaggerJSDoc from "swagger-jsdoc";
-import { serve, setup } from "swagger-ui-express";
+import { startSwagger } from "./utils/swagger";
 
 config();
 
@@ -17,119 +15,7 @@ const app = express();
 app.use(cors());
 app.use(express.json());
 
-const options: swaggerJSDoc.Options = {
-  definition: {
-    openapi: "3.1.0",
-
-    basePath: "http://localhost:5000",
-
-    schemes: ["Hello ", "1", "2"],
-
-    tags: [{ name: "Authentication", description: "Sample tag desc" }],
-
-    host: "http://localhost:5000",
-
-    swagger: "aojvoja",
-
-    consumes: ["aojrg", "oav"],
-
-    externalDocs: {
-      url:""
-    },
-
-    produces:["fg", "fg"],
-
-    info: {
-      title: "UAuthX API Docs",
-      version: "1.0.0",
-      contact: {
-        email: "tanmayvaij22@gmail.com",
-        name: "Tanmay Vaij",
-        url: "https://www.github.com/tanmayvaij"
-      },
-      description:
-        "This is an interactive api documentation for uauthx authentication micro-service",
-      license: {
-        name: "MIT",
-        url: "",
-      },
-      termsOfService: "",
-    },
-
-    servers: [
-      {
-        url: "http://localhost:5000",
-        description: "",
-      },
-    ],
-
-    paths: {
-      "/auth/sign-up": {
-        post: {
-          summary: "User sign up",
-          tags: ["Authentication"],
-
-          requestBody: {
-            required: true,
-            content: {
-              "application/json": {
-                schema: {
-                  type: "object",
-                  required: ["email", "password"],
-                  properties: {
-                    email: {
-                      type: "string",
-                      format: "email",
-                      example: "johndoe@example.com",
-                    },
-                    password: {
-                      type: "string",
-                      format: "password",
-                      example: "Strong_Password@123",
-                    },
-                  },
-                },
-              },
-            },
-          },
-
-          responses: {
-            "200": {
-              description: "",
-              content: {
-                "application/json": {
-                  schema: {
-                    type: "object",
-                    properties: {
-                      isSucess: {
-                        type: "boolean",
-                        example: "true",
-                      },
-                      authToken: {
-                        type: "string",
-                        example: "<your-auth-token>",
-                      },
-                    },
-                  },
-                },
-              },
-            },
-          },
-        },
-      },
-
-      "/auth/sign-in": {
-        post: {
-          tags: ["Authentication"],
-        },
-      },
-    },
-  },
-
-  apis: [],
-};
-
-app.use("/api-docs", serve, setup(swaggerJSDoc(options)));
+startSwagger(app)
 
 app.use("/", rootRouter);
 

src/handlers/signIn.handler.ts → src/handlers/auth/signIn.handler.ts

@@ -1,5 +1,5 @@
 import { Request, Response } from "express";
-import { User } from "../models";
+import { User } from "../../models";
 import { compare } from "bcrypt";
 import { sign } from "jsonwebtoken";
 

src/handlers/signUp.handler.ts → src/handlers/auth/signUp.handler.ts

@@ -1,5 +1,5 @@
 import { Request, Response } from "express";
-import { User } from "../models";
+import { User } from "../../models";
 import { sign } from "jsonwebtoken";
 
 // Sign up request handler
@@ -8,6 +8,8 @@ export const signUp = async (
   res: Response
 ) => {
   try {
+    console.log("/auth/sign-up api called");
+
     // Checking if already the given email exists is database or not
     const userExists = await User.findOne({ email: req.body.email });
 
@@ -28,6 +30,7 @@ export const signUp = async (
     const authToken = sign(payload, process.env.SECRET_KEY!);
 
     return res.json({ isSuccess: true, authToken });
+
   } catch (error) {
     return res.status(500).json({ isSuccess: false, error });
   }

src/handlers/index.ts

@@ -1,6 +1,6 @@
-export * from "./signIn.handler";
-export * from "./signUp.handler";
-export * from "./verifyUser.handler";
+export * from "./auth/signIn.handler";
+export * from "./auth/signUp.handler";
+export * from "./auth/verifyUser.handler";
 
 // admin routes
 export * from "./admin/listUsers.handler";

src/utils/swagger.ts

@@ -0,0 +1,136 @@
+import swaggerJSDoc from "swagger-jsdoc";
+import { serve, setup } from "swagger-ui-express";
+import { Express } from "express";
+
+const options: swaggerJSDoc.Options = {
+  definition: {
+    openapi: "3.1.0",
+
+    tags: [
+        {  
+            name: "Authentication", 
+            description: "Sample tag desc" 
+        }
+    ],
+
+    info: {
+      title: "UAuthX API Docs",
+      version: "1.0.0",
+      contact: {
+        email: "tanmayvaij22@gmail.com",
+        name: "Tanmay Vaij",
+        url: "https://www.github.com/tanmayvaij",
+      },
+      description:
+        "This is an interactive api documentation for uauthx authentication micro-service",
+      license: {
+        name: "MIT",
+        url: "",
+      },
+      termsOfService: "",
+    },
+
+    servers: [
+      {
+        url: "http://localhost:5000",
+        description: "",
+      },
+    ],
+
+    paths: {
+      "/auth/sign-up": {
+        post: {
+          summary: "User sign up",
+          tags: ["Authentication"],
+
+          requestBody: {
+            required: true,
+            content: {
+              "application/json": {
+                schema: {
+                  type: "object",
+                  required: ["email", "password"],
+                  properties: {
+                    email: {
+                      type: "string",
+                      format: "email",
+                      example: "johndoe@example.com",
+                    },
+                    password: {
+                      type: "string",
+                      format: "password",
+                      example: "Strong_Password@123",
+                    },
+                  },
+                },
+              },
+            },
+          },
+
+          responses: {
+            "200": {
+              description: "",
+              content: {
+                "application/json": {
+                  schema: {
+                    type: "object",
+                    properties: {
+                      isSucess: {
+                        type: "boolean",
+                        example: "true",
+                      },
+                      authToken: {
+                        type: "string",
+                        example: "<your-auth-token>",
+                      },
+                    },
+                  },
+                },
+              },
+            },
+
+            "409": {
+              description: "",
+              content: {
+                "application/json": {
+                  schema: {
+                    type: "object",
+                    properties: {
+                      isSuccess: {
+                        type: "boolean",
+                        example: false,
+                      },
+                      error: {
+                        type: "string",
+                        example: "Invalid username or password",
+                      },
+                    },
+                  },
+                },
+              },
+            },
+          },
+        },
+      },
+
+      "/auth/sign-in": {
+        post: {
+          tags: ["Authentication"],
+        },
+      },
+    },
+  },
+
+  apis: [],
+};
+
+export const startSwagger = (app: Express) => {
+  app.use("/api-docs", serve, setup(swaggerJSDoc(options)));
+};
+
+
+interface P {
+    "200": {
+
+    }
+}