Add swagger ui

Author: hirsch88

.env.example

@@ -23,3 +23,12 @@ DB_PASSWORD=""
 DB_DATABASE="my_database"
 DB_SYNCHRONIZE=true
 DB_LOGGING=true
+
+#
+# Swagger
+#
+SWAGGER_ENABLED=true
+SWAGGER_ROUTE="/swagger"
+SWAGGER_FILE="api/swagger.json"
+SWAGGER_USERNAME="admin"
+SWAGGER_PASSWORD="1234"

package.json

@@ -60,6 +60,7 @@
     "cors": "^2.8.4",
     "dotenv": "^4.0.0",
     "express": "^4.16.2",
+    "express-basic-auth": "^1.1.3",
     "figlet": "^1.2.0",
     "helmet": "^3.9.0",
     "lodash": "^4.17.4",
@@ -71,6 +72,7 @@
     "reflect-metadata": "^0.1.10",
     "routing-controllers": "^0.7.6",
     "serve-favicon": "^2.4.5",
+    "swagger-ui-express": "^2.0.10",
     "trash-cli": "^1.4.0",
     "ts-node": "^3.3.0",
     "tslint": "^5.8.0",

src/app.ts

@@ -20,13 +20,15 @@ import { bootstrapMicroframework } from 'microframework';
 import { expressLoader } from './modules/expressLoader';
 import { winstonLoader } from './modules/winstonLoader';
 import { typeormLoader } from './modules/typeormLoader';
+import { swaggerLoader } from './modules/swaggerLoader';
 
 
 bootstrapMicroframework({
     loaders: [
         winstonLoader,
         expressLoader,
-        typeormLoader
+        typeormLoader,
+        swaggerLoader
         // here we can setup other databases, any other lib we want to setup in our application
     ]
 })

src/core/env.ts

@@ -1,10 +1,14 @@
+const pkg = require('../../package.json');
+
 /**
  * Environment variables
  */
 export const env = {
     node: process.env.NODE_ENV || 'development',
     app: {
         name: getOsEnv('APP_NAME'),
+        version: pkg.version,
+        description: pkg.description,
         host: getOsEnv('APP_HOST'),
         port: normalizePort(process.env.PORT || '3000'),
         routePrefix: getOsEnv('APP_ROUTE_PREFIX')
@@ -23,6 +27,13 @@ export const env = {
         database: getOsEnv('DB_DATABASE'),
         synchronize: toBool(getOsEnv('DB_SYNCHRONIZE')),
         logging: toBool(getOsEnv('DB_LOGGING'))
+    },
+    swagger: {
+        enabled: toBool(getOsEnv('SWAGGER_ENABLED')),
+        route: getOsEnv('SWAGGER_ROUTE'),
+        file: getOsEnv('SWAGGER_FILE'),
+        username: getOsEnv('SWAGGER_USERNAME'),
+        password: getOsEnv('SWAGGER_PASSWORD')
     }
 };
 

src/modules/swaggerLoader.ts

@@ -0,0 +1,33 @@
+import * as path from 'path';
+import * as swaggerUi from 'swagger-ui-express';
+import * as basicAuth from 'express-basic-auth';
+import { MicroframeworkSettings, MicroframeworkLoader } from 'microframework';
+import { env } from '../core/env';
+
+
+export const swaggerLoader: MicroframeworkLoader = (settings: MicroframeworkSettings | undefined) => {
+    if (settings && env.swagger.enabled) {
+        const expressApp = settings.getData('express_app');
+        const swaggerFile = require(path.join(__dirname, '..', env.swagger.file));
+
+        // Add npm infos to the swagger doc
+        swaggerFile.info = {
+            title: env.app.name,
+            description: env.app.description,
+            version: env.app.version
+        };
+
+        expressApp.use(
+            env.swagger.route,
+            basicAuth({
+                users: {
+                    [`${env.swagger.username}`]: env.swagger.password
+                },
+                challenge: true
+            }),
+            swaggerUi.serve,
+            swaggerUi.setup(swaggerFile)
+        );
+
+    }
+};

tslint.json

@@ -6,6 +6,7 @@
             160
         ],
         "no-unnecessary-initializer": false,
+        "no-var-requires": false,
         "no-consecutive-blank-lines": false,
         "quotemark": [true, "single", "avoid-escape"],
         "interface-name": false,

yarn.lock

@@ -515,6 +515,10 @@ balanced-match@^1.0.0:
   version "1.0.0"
   resolved "https://registry.yarnpkg.com/balanced-match/-/balanced-match-1.0.0.tgz#89b4d199ab2bee49de164ea02b89ce462d71b767"
 
+basic-auth@^1.1.0:
+  version "1.1.0"
+  resolved "https://registry.yarnpkg.com/basic-auth/-/basic-auth-1.1.0.tgz#45221ee429f7ee1e5035be3f51533f1cdfd29884"
+
 basic-auth@~2.0.0:
   version "2.0.0"
   resolved "https://registry.yarnpkg.com/basic-auth/-/basic-auth-2.0.0.tgz#015db3f353e02e56377755f962742e8981e7bbba"
@@ -1343,6 +1347,12 @@ expect@^21.2.1:
     jest-message-util "^21.2.1"
     jest-regex-util "^21.2.0"
 
+express-basic-auth@^1.1.3:
+  version "1.1.3"
+  resolved "https://registry.yarnpkg.com/express-basic-auth/-/express-basic-auth-1.1.3.tgz#18924c02fef18d9efe58e22847ee31e240749f33"
+  dependencies:
+    basic-auth "^1.1.0"
+
 express@^4.16.2:
   version "4.16.2"
   resolved "https://registry.yarnpkg.com/express/-/express-4.16.2.tgz#e35c6dfe2d64b7dca0a5cd4f21781be3299e076c"
@@ -4086,6 +4096,10 @@ supports-color@^4.0.0:
   dependencies:
     has-flag "^2.0.0"
 
+swagger-ui-express@^2.0.10:
+  version "2.0.10"
+  resolved "https://registry.yarnpkg.com/swagger-ui-express/-/swagger-ui-express-2.0.10.tgz#a7beb3e44ad0abd3c9915afc6b41cb87a91aa3e7"
+
 symbol-tree@^3.2.1:
   version "3.2.2"
   resolved "https://registry.yarnpkg.com/symbol-tree/-/symbol-tree-3.2.2.tgz#ae27db38f660a7ae2e1c3b7d1bc290819b8519e6"