Documentation

package.json

@@ -31,6 +31,7 @@
     "nodemailer": "^6.7.2",
     "npm-run-all": "^4.1.5",
     "supertest": "^6.2.2",
+    "swagger-ui-express": "^4.3.0",
     "winston": "^3.5.1",
     "yarn-upgrade-all": "^0.6.1"
   },

src/app.js

@@ -1,18 +1,13 @@
 const express = require('express');
-
 require('dotenv').config();
-
 const cookieParser = require('cookie-parser');
+const swaggerUi = require('swagger-ui-express');
+const swaggerDocument = require('./swagger.json');
 const { connectToMongo } = require('./db/connection');
-
 const authRoutes = require('./routers/auth');
-
 const itemRoutes = require('./routers/item');
-
 const userRoutes = require('./routers/user');
-
 const globalRoutes = require('./routers/global');
-
 const logger = require('./services/logger');
 
 const app = express();
@@ -30,6 +25,16 @@ app.use('/api/items', itemRoutes);
 app.use('/api/users', userRoutes);
 app.use('/api/global', globalRoutes);
 
+const options = {
+  customCss: '.swagger-ui .topbar { display: none }',
+};
+
+app.use(
+  '/api/docs',
+  swaggerUi.serve,
+  swaggerUi.setup(swaggerDocument, options)
+);
+
 const server = app.listen(port, () => {
   logger.log('info', `Server is running on port ${port}`);
   connectToMongo();

src/controllers/auth.js

@@ -41,6 +41,8 @@ module.exports = {
         maxAge: cookieAge * 1000,
         httpOnly: true,
       });
+      // This header is set for swagger users to access the token easily
+      res.setHeader('authorizationToken', token);
       res.json({ message: 'Successfully signed in' });
     } catch (err) {
       res.status(422).json({ message: err.message ?? err });

src/middlewares/user-authentication.js

@@ -3,7 +3,10 @@
 const jwt = require('jsonwebtoken');
 
 module.exports = (req, res, next) => {
-  const { token } = req.cookies;
+  let { token } = req.cookies;
+  if (req?.headers?.swaggerToken) {
+    token = req.headers.swaggerToken;
+  }
   try {
     const { user } = jwt.verify(token, process.env.JWT_SECRET);
     // if verified pass the user to the next function with the req object