added swagger ui

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

package.json

@@ -11,19 +11,21 @@
     "build": "tsc -p ."
   },
   "dependencies": {
+    "@types/swagger-jsdoc": "^6.0.4",
+    "@types/swagger-ui-express": "^4.1.6",
     "bcrypt": "^5.1.1",
     "cors": "^2.8.5",
     "dotenv": "^16.4.5",
     "express": "^4.19.2",
-    "js-yaml": "^4.1.0",
     "jsonwebtoken": "^9.0.2",
-    "mongoose": "^8.4.0"
+    "mongoose": "^8.4.0",
+    "swagger-jsdoc": "^6.2.8",
+    "swagger-ui-express": "^5.0.1"
   },
   "devDependencies": {
     "@types/bcrypt": "^5.0.2",
     "@types/cors": "^2.8.17",
     "@types/express": "^4.17.21",
-    "@types/js-yaml": "^4.0.9",
     "@types/jsonwebtoken": "^9.0.6",
     "@types/node": "^20.12.12",
     "nodemon": "^3.1.1",

src/app.ts

@@ -7,13 +7,130 @@ import { connectToDatabase } from "./database";
 
 import { checkEnvVariables } from "./utils/checkEnvVariables";
 
+import swaggerJSDoc from "swagger-jsdoc";
+import { serve, setup } from "swagger-ui-express";
+
 config();
 
 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)));
+
 app.use("/", rootRouter);
 
 const startServer = async () => {