Integrate swagger Documentation

Readme.md

@@ -1,6 +1,8 @@
 # Send-AM
 SendAM is a courier service that helps users deliver parcels to different destinations. SendIT provides courier quotes based on weight categories.
 
+![Test Image 1](https://github.com/Ejiro-Edwin/SendAm/tree/master/Server/API_INT.png)
+
 ## Feature
 * There are two types of users admin and regular user
 * Users can Register if they have no account or login otherwise

Server/app.js

@@ -2,22 +2,19 @@ const express = require('express');
 const bodyParser = require('body-parser');
 const path = require('path');
 const cors = require('cors');
-const mysql=require('mysql');
-const db = require('./config/db');
-
-// const swagger = require("swagger-ui-express");
-// import swaggerDocument from "../swagger.js";
+const swagger = require("swagger-ui-express");
+const swaggerDocument = require("../Swagger.js");
 
 let app = express();
 
 
 const parcelRoute = require('./routes/parcels');
 const userRoute = require('./routes/users');
 const authRoute = require('./routes/auth');
+app.use("/docs", swagger.serve, swagger.setup(swaggerDocument));
 
 app.set('views', path.join(__dirname, 'views'));
 
-// app.use(bodyParser.urlencoded({ extended: false }))
 app.use(bodyParser.json());
 app.use(bodyParser.urlencoded({ extended: true }));
 
@@ -40,15 +37,14 @@ app.all('/*', function(req, res, next) {
 app.use('/api/v1/auth', authRoute)
 app.use('/api/v1/parcels', parcelRoute)
 app.use('/api/v1/users', userRoute)
-// app.use("/docs", swagger.serve, swagger.setup(swaggerDocument));
 
 app.get('/', (req, res) => {
  return res.status(200).json({ msg: 'Welcome to new SendAM API.'});
 });
 
-// app.use(function (err, req, res, next) {
-//  res.status(500).send('Something wrong broke!');
-// })
+ app.use(function (err, req, res, next) {
+ res.status(500).send('Something wrong broke!');
+ })
 
 const port = process.env.PORT || 10000;
 

Server/config/db.js

@@ -12,6 +12,18 @@ const sequelize = new Sequelize('sendit', 'root', '', {
  idle: 10000
  }
 })
+// const sequelize = new Sequelize(process.env.DATABASE, process.env.USER, '', {
+// host: process.env.DATABASE || 'localhost',
+// dialect: 'mysql',
+// operatorsAliases: false,
+
+// pool: {
+// max: 5,
+// min: 0,
+// acquire: 30000,
+// idle: 10000
+// }
+// })
 
 db.sequelize = sequelize
 db.Sequelize = Sequelize

Server/controllers/ParcelsController.js

@@ -120,7 +120,7 @@ class Parcels {
 
  static cancel(req, res) {
  const newStatus = 'canceled';
- Parcel.update(
+ parcel.update(
  {status:newStatus},
  {where : {
  id : req.params.id,
@@ -149,7 +149,7 @@ class Parcels {
 
  const newDestination = req.body.toAddress
 
- Parcel.update(
+ parcel.update(
  {toAddress:newDestination},
  {where : {
  id : req.params.id,
@@ -180,7 +180,7 @@ class Parcels {
 
  const currentLocation = req.body.currentLocation
 
- Parcel.update(
+ parcel.update(
  {toAddress:currentLocation},
  {where : {
  id : req.params.id
@@ -212,7 +212,7 @@ static changeStatus(req, res) {
  if (fieldError.error) return res.status(400).send(fieldError.error.details[0].message);
 
  const status = req.body.status
- Parcel.update(
+ parcel.update(
  {status:status},
  {where : {
  id : req.params.id,

Server/controllers/UsersController.js

@@ -1,5 +1,4 @@
 const moment = require ('moment');
-// const db = require('../config/db');
 const dotenv = require('dotenv');
 const helper = require ('../helpers/helper');
 const Users = require('../models/users');

Server/helpers/helper.js

@@ -2,6 +2,7 @@ const bcrypt = require('bcryptjs');
 const jwt = require('jsonwebtoken');
 const dotenv = require('dotenv');
 const sgMail = require('@sendgrid/mail');
+const config = require('config');
 
 dotenv.config();
 
@@ -17,7 +18,7 @@ const helper = {
  generateToken(payload) {
  const token = jwt.sign(
  payload,
- "secret", { expiresIn: '20d' }
+ config.get('SECRET'), { expiresIn: '20d' }
  );
  return token;
  },
@@ -32,7 +33,7 @@ const helper = {
  html: "Your PDO has been updated",
  };
  sgMail.send(mail);
- }
+ },
 }
 
 module.exports = helper;

Server/middleware/auth.js

@@ -17,31 +17,7 @@ class Auth {
  res.status(400).send('Invalid Token');
  }
 
- // jwt.verify(req.token, process.env.SECRET , (err, data) => {
- // if (err) {
- // res.status(403).send("You cannot access this page because you require a token to access it");
- // } else {
- // req.user = data.userId,
- // req.adminStatus = data.isAdmin
- // next()
- // }
- // })
- } 
  }
+}
 
-
-module.exports = Auth;
-
-// module.exports = function(req,res,next){
-// const token = req.header('x-auth-token');
-// if(!token) return res.status(401).send('Access Denied. No token provided');
-
-// try {
-// const decoded = jwt.verify(token, config.get('JwtPrivateKey'));
-// req.user = decoded;
-// next();
-// } catch (ex) {
-// res.status(400).send('Invalid Token');
-// }
-
-// }
+module.exports = Auth;