Added swagger-jsdoc, modify code

No need to run from cli swagger-jsdoc, that is retarded, do it automatically.

Author: norkator

package-lock.json

@@ -33,7 +33,7 @@
     "sequelize": "5.21.13"
   },
   "devDependencies": {
-    "@types/sequelize": "4.28.9",
+    "@types/swagger-jsdoc": "3.0.2",
     "@types/bcrypt": "3.0.0",
     "@types/compression": "1.7.0",
     "@types/cookie-parser": "1.4.2",
@@ -42,6 +42,7 @@
     "@types/express": "4.17.6",
     "@types/helmet": "0.0.47",
     "@types/jsonwebtoken": "8.5.0",
+    "@types/sequelize": "4.28.9",
     "@types/swagger-ui-express": "4.1.2",
     "swagger-jsdoc": "4.0.0",
     "swagger-ui-express": "4.1.4"

package.json

@@ -7,7 +7,82 @@ import {Router} from 'express';
 const router: Router = Router();
 
 
+/**
+ * POST method route
+ * @example http://localhost:PORT/auth/create-account
+ *
+ * @swagger
+ * /auth/create-account:
+ *   post:
+ *      description: Create new User
+ *      tags: ["users"]
+ *      security:
+ *       - bearerAuth: []
+ *      requestBody:
+ *        description: user creation request body
+ *        required: true
+ *        content:
+ *          application/json:
+ *            schema:
+ *              $ref: ''
+ *            example:
+ *              name: Test User
+ *              email: [email protected]
+ *              password: toohardpasswd
+ *      responses:
+ *        201:
+ *          description: return created user
+ *          content:
+ *            application/json:
+ *              schema:
+ *                oneOf:
+ *                  - $ref: ''
+ *        default:
+ *          description: unexpected error
+ *          content:
+ *            application/json:
+ *              schema:
+ *                $ref: ''
+ */
 router.post('/create-account', AuthenticationComponent.createAccount);
+
+
+/**
+ * POST method route
+ * @example http://localhost:PORT/auth/login
+ *
+ * @swagger
+ * /auth/login:
+ *   post:
+ *      description: Login with existing account
+ *      tags: ["users"]
+ *      security:
+ *       - bearerAuth: []
+ *      requestBody:
+ *        description: user login request body
+ *        required: true
+ *        content:
+ *          application/json:
+ *            schema:
+ *              $ref: ''
+ *            example:
+ *              email: [email protected]
+ *              password: toohardpasswd
+ *      responses:
+ *        201:
+ *          description: return login user and token
+ *          content:
+ *            application/json:
+ *              schema:
+ *                oneOf:
+ *                  - $ref: ''
+ *        default:
+ *          description: unexpected error
+ *          content:
+ *            application/json:
+ *              schema:
+ *                $ref: ''
+ */
 router.post('/login', AuthenticationComponent.login);
 
 /**

src/routes/AuthenticationRouter.ts

@@ -1,22 +1,21 @@
 import * as express from 'express';
 import * as http from 'http';
+import * as swaggerJsdoc from 'swagger-jsdoc'
 import * as swaggerUi from 'swagger-ui-express';
 import * as jwtConfig from '../server/jwtAuth';
 
 import AuthenticationRouter from '../routes/AuthenticationRouter'
 import ExampleRouter from '../routes/ExampleRouter'
 
-let swaggerDoc: Object;
 
-try {
-    swaggerDoc = require('../../swagger.json');
-} catch (error) {
-    console.log('***************************************************');
-    console.log('  Seems like you doesn\`t have swagger.json file');
-    console.log('  Please, run: ');
-    console.log('  $ swagger-jsdoc -d swagger.js -o swagger.json');
-    console.log('***************************************************');
-}
+const swaggerOptions = require('../../swagger');
+
+
+const swaggerSpecs = swaggerJsdoc(swaggerOptions);
+
+
+
+
 
 /**
  * @export
@@ -42,16 +41,8 @@ export function init(app: express.Application): void {
      *  else send commands, how to get swagger.json file
      * @constructs
      */
-    if (swaggerDoc) {
-        app.use('/docs', swaggerUi.serve);
-        app.get('/docs', swaggerUi.setup(swaggerDoc));
-    } else {
-        app.get('/docs', (req, res) => {
-            res.send('<p>Seems like you don\'t have <code>swagger.json</code> file.</p>' +
-                '<p>For generate doc file use: <code>swagger-jsdoc -d swagger.js -o swagger.json</code> in terminal</p>' +
-                '<p>Then, restart your application</p>');
-        });
-    }
+    app.use('/docs', swaggerUi.serve);
+    app.get('/docs', swaggerUi.setup(swaggerSpecs));
 
     /**
      * @description No results returned mean the object is not found

src/routes/index.ts

@@ -1,14 +1,19 @@
 const path = require('path');
+const dotEnv = require('dotenv');
+
+dotEnv.config();
 
 module.exports = {
-    openapi: '3.0.0',
-    info: {
-        title: 'Node-Typescript API',
-        version: '1.0.0',
-        description: 'Node Express Orm Typescript template api',
+    swaggerDefinition: {
+        components: {},
+        openapi: '3.0.0',
+        info: {
+            title: 'Node-Typescript API',
+            version: '1.0.0',
+            description: 'Node Express Orm Typescript Template API',
+        },
+        "host": 'http://localhost:' + process.env.PORT,
     },
-    servers: [
-        { url: 'http://localhost:3000' }
-    ],
     apis: [path.join(__dirname, './src/**/**/*.ts')]
 };
+