Add mui and swagger docs

Author: nicolelim02

backend/question-service/index.js

@@ -1,20 +1,28 @@
 const express = require("express");
 const dotenv = require("dotenv");
 const path = require("path");
+const swaggerUi = require("swagger-ui-express");
+const yaml = require("yaml");
+const fs = require("fs");
 
 const envFilePath = path.join(
   path.resolve(path.dirname(path.dirname(__dirname))),
-  ".env"
+  ".env",
 );
 
+const file = fs.readFileSync("./swagger.yml", "utf-8");
+const swaggerDocument = yaml.parse(file);
+
 dotenv.config({ path: envFilePath });
 
 const app = express();
 
 const PORT = process.env.QUESTION_SERVICE_PORT || 3000;
 
 app.get("/", (req, res) => {
-  res.json({ message: "Hello World from question-service" });
+  res.status(200).json({ message: "Hello World from question-service" });
 });
 
+app.use("/docs", swaggerUi.serve, swaggerUi.setup(swaggerDocument));
+
 app.listen(PORT, () => console.log(`Listening on port ${PORT}`));

backend/question-service/package-lock.json

@@ -12,9 +12,12 @@
   "description": "",
   "dependencies": {
     "axios": "^1.7.7",
+    "body-parser": "^1.20.3",
     "dotenv": "^16.4.5",
     "express": "^4.20.0",
-    "mongoose": "^8.6.1"
+    "mongoose": "^8.6.1",
+    "swagger-ui-express": "^5.0.1",
+    "yaml": "^2.5.1"
   },
   "devDependencies": {
     "@eslint/js": "^9.10.0",

backend/question-service/package.json

@@ -0,0 +1,24 @@
+openapi: 3.0.0
+
+info:
+  title: Question Service
+  version: 1.0.0
+
+paths:
+  /:
+    get:
+      tags:
+        - root
+      summary: Root
+      description: Ping the server
+      responses:
+        "200":
+          description: Successful Response
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  message:
+                    type: string
+                    description: Message