Merge pull request #44 from RCDD-202110-TUR-BEW/documentation

Documentation

package.json

@@ -35,6 +35,7 @@
     "passport": "^0.5.2",
     "passport-google-oauth20": "^2.0.0",
     "supertest": "^6.2.2",
+    "swagger-ui-express": "^4.3.0",
     "unique-username-generator": "^1.0.1",
     "winston": "^3.5.1",
     "yarn-upgrade-all": "^0.6.1"

src/app.js

@@ -1,10 +1,12 @@
 const express = require('express');
-const path = require('path');
 require('dotenv').config();
 const cookieParser = require('cookie-parser');
+const swaggerUi = require('swagger-ui-express');
+const path = require('path');
 const passport = require('passport');
 const GoogleStrategy = require('passport-google-oauth20').Strategy;
 const session = require('express-session');
+const swaggerDocument = require('./swagger.json');
 const { connectToMongo } = require('./db/connection');
 const authRoutes = require('./routers/auth');
 const itemRoutes = require('./routers/item');
@@ -50,6 +52,16 @@ app.use('/api/items', itemRoutes);
 app.use('/api/users', userRoutes);
 app.use('/api/requests', requestRoutes);
 app.use('/api/global', globalRoutes);
+
+const options = {
+  customCss: '.swagger-ui .topbar { display: none }',
+};
+
+app.use(
+  '/api/docs',
+  swaggerUi.serve,
+  swaggerUi.setup(swaggerDocument, options)
+);
 app.use('/', (req, res) => {
   res.render('home');
 });

src/controllers/auth.js

@@ -41,6 +41,7 @@ module.exports = {
         maxAge: cookieAge * 1000,
         httpOnly: true,
       });
+
       res.json({ message: 'Successfully signed in' });
     } catch (err) {
       res.status(422).json({ message: err.message ?? err });