Add API versioning to the project. Update package.json version to 1.0.9, modify route manager to use v1 routes, and move hello and user routes to v1 subdirectory. Update Swagger documentation to include v1 endpoints

Author: gulalicelik

CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+
+## [1.7.0]() (2023-03-30)
+
+### Features
+
+- add API versioning 
+

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@gulali/nodejs-express-sequelize-mysql-api-boilerplate",
-  "version": "1.0.8",
+  "version": "1.0.9",
   "description": "Nodejs Express Sequelize Mysql API Boilerplate with JWT, Swagger, Winston, PM2",
   "main": "index.js",
   "publishConfig": {

package.json

@@ -1,12 +1,13 @@
-const userRoute = require('./user.route');
-const helloRoute = require('./hello.route');
-const swaggerUi = require('swagger-ui-express');
-const swaggerDocument = require('../swagger.js');
+const userRoute = require('./v1/user.route');
+const helloRoute = require('./v1/hello.route');
+
 
 
 const routeManager = (app) => {
-    app.use('/', helloRoute);
-    app.use('/user', userRoute);
+
+    // API V1 Routes
+    app.use('/v1/', helloRoute);
+    app.use('/v1/user', userRoute);
 
 }
 

route/route.manager.js

@@ -1,7 +1,7 @@
 const express = require('express');
 const router = express.Router();
 
-const helloController = require('../controller/hello.controller.js');
+const helloController = require('../../controller/hello.controller.js');
 
 /**
  * @openapi

route/hello.route.js renamed to route/v1/hello.route.js

@@ -1,8 +1,8 @@
 const express = require('express');
 const router = express.Router();
-const userController = require('../controller/user.controller.js');
-const validator = require('../middleware/validators.js');
-const auth = require("../middleware/auth");
+const userController = require('../../controller/user.controller.js');
+const validator = require('../../middleware/validators.js');
+const auth = require("../../middleware/auth");
 
 router.post('/signin', validator.validateSignIn, userController.signIn);
 router.post('/signup', validator.validateSignUp, userController.signUp);

route/user.route.js renamed to route/v1/user.route.js

@@ -1,32 +1,32 @@
 const  swaggerJsdoc  = require('swagger-jsdoc');
 const  swaggerUi  = require('swagger-ui-express');
 
-const options = {
+const optionsV1 = {
     definition: {
         openapi: '3.0.0',
         info: {
-            title: 'Hero API',
-            description: 'Example of CRUD API ',
+            title: 'My Boilerplate API',
+            description: 'nodejs-express-mysql-api-boilerplate API ',
             version: '1.0.0',
         },
     },
     // looks for configuration in specified directories
-    apis: ['./route/*.js', './controller/*.js', './middleware/*.js'],
+    apis: ['./route/v1/*.js', './controller/*.js', './middleware/*.js'],
 }
 
-const swaggerSpec = swaggerJsdoc(options)
+const swaggerSpecV1 = swaggerJsdoc(optionsV1)
 
 function swaggerDocs(app, port) {
     console.log(`:::::::::::::::: SWAGGER RUNNING ON ${port}.`)
 
-    // Swagger Page
-    app.use('/docs', swaggerUi.serve, swaggerUi.setup(swaggerSpec))
-
+    // Swagger Page For API V1
+    app.use('/v1/docs', swaggerUi.serve, swaggerUi.setup(swaggerSpecV1))
     // Documentation in JSON format
-    app.get('/docs-json', (req, res) => {
+    app.get('/v1/docs-json', (req, res) => {
         res.setHeader('Content-Type', 'application/json')
-        res.send(swaggerSpec)
+        res.send(swaggerSpecV1)
     })
+
 }
 
 module.exports = swaggerDocs