Add new swagger generation

Author: Archit404Error

backend/package.json

@@ -12,9 +12,10 @@
     "body-parser": "^1.20.1",
     "dotenv": "^16.0.3",
     "express": "^4.18.2",
-    "express-oas-generator": "^1.0.46",
     "jest": "^29.3.1",
     "mongoose": "^6.8.4",
+    "swagger-autogen": "^2.22.0",
+    "swagger-ui-express": "^4.6.0",
     "ts-jest": "^29.0.5",
     "ts-node": "^10.9.1",
     "typescript": "^4.9.4"
@@ -23,6 +24,7 @@
     "start": "ts-node -r dotenv/config src/index.ts",
     "dev": "nodemon -r dotenv/config src/index.ts",
     "build": "tsc",
-    "test": "jest"
+    "test": "jest",
+    "swagger": "ts-node -r dotenv/config src/swagger.ts"
   }
 }

backend/src/index.ts

@@ -2,15 +2,9 @@ import express from "express";
 import bodyParser from "body-parser";
 import userRouter from "./users/views";
 import customerRouter from "./customers/views";
-import expressOasGenerator from "express-oas-generator";
 import { dbConnect } from "./database";
 
 const app = express();
-expressOasGenerator.handleResponses(app, {
-  specOutputPath: "swagger.json",
-  specOutputFileBehavior: "merge",
-  swaggerDocumentOptions: undefined,
-});
 
 // Middleware to parse json request bodies
 app.use(bodyParser.json());
@@ -32,8 +26,6 @@ app.post("/", (req, res) => {
   res.send(req.body);
 });
 
-expressOasGenerator.handleRequests();
-
 app.listen(process.env.PORT || 3000, async () => {
   console.log("✅ Server is up and running");
   await dbConnect();

backend/src/swagger.ts

@@ -0,0 +1,34 @@
+import swaggerAutogen from "swagger-autogen";
+
+const doc = {
+  info: {
+    version: "1.0.0",
+    title: "My API",
+    description:
+      "Documentation automatically generated by the <b>swagger-autogen</b> module.",
+  },
+  host: "localhost:3000",
+  basePath: "/",
+  schemes: ["http", "https"],
+  consumes: ["application/json"],
+  produces: ["application/json"],
+  tags: [
+    {
+      name: "User",
+      description: "Endpoints",
+    },
+  ],
+  securityDefinitions: {
+    apiKeyAuth: {
+      type: "apiKey",
+      in: "header", // can be "header", "query" or "cookie"
+      name: "X-API-KEY", // name of the header, query parameter or cookie
+      description: "any description...",
+    },
+  },
+};
+
+const outputFile = "../api-spec.json";
+const endpointsFiles = ["./index.ts"];
+
+swaggerAutogen()(outputFile, endpointsFiles, doc);