add swagger docs

shobhamrj · May 20, 2023 · 718985b · 718985b
1 parent d8996b6
commit 718985b
Show file tree

Hide file tree

Showing 4 changed files with 286 additions and 10 deletions.
diff --git a/index.js b/index.js
@@ -1,16 +1,20 @@
 const serverless = require('serverless-http');
 const express = require('express');
 const mongoose = require('mongoose');
+const swaggerUi = require('swagger-ui-express')
+const YAML = require('yamljs')
 require('dotenv').config()
 
 const app = express();
 app.use(express.json());
 const DB_URI = process.env.MONGO_URI
+const swaggerDocument = YAML.load('./swagger.yaml')
 
 mongoose.connect(DB_URI, { useUnifiedTopology: true, useNewUrlParser: true })
     .then(() => console.log('Connected to MongoDB'))
     .catch(e => console.log('Error connecting to MongoDB:', e))
 
+app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument))
 app.use('/', require('./routes/urlRoutes'))
 
 module.exports = app;

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -8,7 +8,10 @@
     "express": "^4.18.2",
     "mongoose": "^7.2.0",
     "serverless-http": "^3.1.1",
-    "serverless-offline": "^12.0.4"
+    "serverless-offline": "^12.0.4",
+    "swagger-jsdoc": "^6.2.8",
+    "swagger-ui-express": "^4.6.3",
+    "yamljs": "^0.3.0"
   },
   "devDependencies": {
     "chai": "^4.3.7",