Swagger docs implemented.

Author: akashanand708

NodeServerBackendBackup

@@ -1,11 +1,2 @@
-RUN SQL SERVER
-/usr/local/mysql/bin/mysql -u root -p
 
-UPDATE mysql.USER
-SET plugin = OLD_PASSWORD('Akash@28')
-WHERE USER='root'
-AND host='localhost';
-
- UPDATE mysql.user
- SET password='Akash@28' WHERE user='root';
- FLUSH PRIVILEGES;
+ 

README.md

@@ -1,15 +1,42 @@
 # nodeserver-backend-boilerplate
 
-> Boilerplate for API Server written in Node.js and ES6.
+> A complete initial boilerplate for API Server written in Node.js and ES6.
 
-## Requirements
+## Key feature
+1. 
+# API exposed
+> /api/v1/register         -For signUp.
+> /api/v1/login            -For logIn.
+> /api/v1/logout           -For logOut.
+> /api/v1/resetPassword    -For reset password.
+> /api/v1/updatePassword   -For update password.
+
+2. 
+# Proper error handling.
+
+3. 
+# nodemailer implemented for Reset Password.
+
+4. 
+# For encryption/decryption, methods have been written in CRYPT.JS
+
+5. 
+# All APIs can be seen in SWAGGER DOCS on http://localhost:5001/api-docs/
 
-## API exposed
-> /register         -For signUp.
-> /login            -For logIn.
-> /logout           -For logOut.
-> /resetPassword    -For reset password.
+# swagger configuration
+- After starting the server in development mode swagger can be run with this url.
+  http://localhost:5001/api-docs/
 
+- After adding any new API, need to update SWAGGER.js for that API.
+
+# nodemailer configuration
+- To configure email service, need to update CONSTANT.JS.
+- In CONSTANT.js, encrypted password should be used.For encryption/decryption, methods have been written in      CRYPT.JS
+
+## Requirements
+To start any WEB or MOBILE application, we need complete package of REST APIs
+like signup/login/logout/resetPassword/UpdatePassword.
+This boilerplate can be used.
 
 ## Dependencies
 
@@ -36,5 +63,4 @@ npm run build
 # run for production.
 npm run serve
 ```
-
 ## License

config/database-config.js

@@ -3,8 +3,8 @@ export default {
 		host: 'localhost',
 		user: 'root',
 		password: 'Akash@28',
-		database: 'user',
-		//port: 5432,
+		database: 'book_finder',
+		port: 3306,
 		max: 10, //set pool max size to 20
 		min: 2, //set min pool size to 4
 		//idleTimeoutMillis: 5000 //close idle clients after 5 second

package.json

@@ -33,6 +33,7 @@
     "mysql": "^2.15.0",
     "nodemailer": "^4.6.4",
     "restify-errors": "^6.0.0",
+    "swagger-ui-express": "^3.0.9",
     "winston": "^2.4.2"
   }
 }

src/models/User.js

@@ -44,10 +44,10 @@ export function saveUserDetails(name, email, password, next) {
 			console.log('Save userDetails get connection SqlError...', sqlError);
 			return next(new error.InternalServerError(ERROR_MESSAGE.SOMETING_WENT_WRONG));
 		}
-		let sql = 'INSERT INTO USER (name, email,password,jwt_token) VALUES ?';
+		let sql = 'INSERT INTO USER (name, email,password,jwt_token,reset_password_token) VALUES ?';
 		let jwtToken = generateJwtToken(name, email);
 		let values = [
-			[name, email, encryptPassword(password), jwtToken]
+			[name, email, encryptPassword(password), jwtToken,null]
 		];
 		connection.query(sql, [values], function (err, result) {
 			connection.release();

src/routers/authRouter.js

@@ -3,7 +3,7 @@ import * as authController from '../controllers/authController.js';
 export default (router) => {
 	router.post('/register', authController.signUp);
 	router.patch('/login', authController.logIn);
-	router.patch('/logout', authController.logOut);
+	router.delete('/logout', authController.logOut);
 	router.patch('/resetPassword', authController.resetPassword);
 	router.patch('/updatePassword', authController.updatePassword);
 

src/server.js

@@ -2,8 +2,9 @@ import express from 'express';
 import bodyParser from 'body-parser';
 import cookieParser from 'cookie-parser';
 import multer from 'multer';
-import mysql from 'mysql';
-import databaseConfig from '../config/database-config';
+import swaggerUi from'swagger-ui-express';
+import swaggerDocument from './swagger';
+
 import rootRouter from './routers/index';
 import { customErrorHandler, uncaughtExceptionHandler, pgPoolErrorHandler } from './middlewares/errorHandlers';
 var upload = multer();
@@ -12,6 +13,8 @@ var upload = multer();
 var app = express();
 
 /***************** Middleware before routing **************/
+
+app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));
 /** Error handler */
 //An error handling middleware
 // TODOprocess.on('uncaughtException', uncaughtExceptionHandler(app));
@@ -29,7 +32,7 @@ app.use(cookieParser());
 // let connectionConfig = databaseConfig[process.env.NODE_ENV];
 // let connectionPool = mysql.createPool(connectionConfig);
 /** Root Router */
-app.use('/', rootRouter,function(next){
+app.use('/api/v1', rootRouter,function(next){
 	next();
 });