[Core] Improve Interface for swagger documentation

README.md

@@ -16,15 +16,15 @@ const document = new DocumentBuilder()
         title: 'Express application',
         version: '1.0',
         // Below fields are optional
-        description: 'Description';
-        termsOfService: 'http://swagger.io/terms/';
+        description: 'Description',
+        termsOfService: 'http://swagger.io/terms/',
         contact: {
-            name: 'Phu';
-            email: '[email protected]';
-        };
+            name: 'Phu',
+            email: '[email protected]',
+        },
         license: {
-            name: 'Apache 2.0';
-            url: 'http://www.apache.org/licenses/LICENSE-2.0.html';
-        };
+            name: 'Apache 2.0',
+            url: 'http://www.apache.org/licenses/LICENSE-2.0.html',
+        },
     })
 ```

example/01-express-example/.eslintrc.js

@@ -0,0 +1,25 @@
+module.exports = {
+    parser: '@typescript-eslint/parser',
+    parserOptions: {
+      project: 'tsconfig.json',
+      sourceType: 'module',
+    },
+    plugins: ['@typescript-eslint/eslint-plugin'],
+    extends: [
+      'plugin:@typescript-eslint/recommended',
+      'plugin:prettier/recommended',
+    ],
+    root: true,
+    env: {
+      node: true,
+      jest: true,
+    },
+    ignorePatterns: ['.eslintrc.js'],
+    rules: {
+      '@typescript-eslint/interface-name-prefix': 'off',
+      '@typescript-eslint/explicit-function-return-type': 'off',
+      '@typescript-eslint/explicit-module-boundary-types': 'off',
+      '@typescript-eslint/no-explicit-any': 'off',
+    },
+  };
+

example/01-express-example/.gitignore

@@ -0,0 +1,35 @@
+# compiled output
+/dist
+/node_modules
+
+# Logs
+logs
+*.log
+npm-debug.log*
+pnpm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# OS
+.DS_Store
+
+# Tests
+/coverage
+/.nyc_output
+
+# IDEs and editors
+/.idea
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# IDE - VSCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json

example/01-express-example/.prettierrc

@@ -0,0 +1,4 @@
+{
+    "singleQuote": true,
+    "trailingComma": "all"
+  }

example/01-express-example/nodemon.json

@@ -0,0 +1,6 @@
+{
+    "watch": ["src"],
+    "ext": ".js",
+    "ignore": [],
+    "exec": "node ./src/index.js"
+}

example/01-express-example/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "lite-express-swagger",
+  "version": "1.0.0",
+  "main": "dist/index.ts",
+  "license": "MIT",
+  "dependencies": {
+    "express": "^4.17.1",
+    "swagger-ui-express": "^4.1.6",
+    "lite-express-swagger": "../../lib"
+  },
+  "scripts": {
+    "prebuild": "rimraf dist",
+    "build": "yarn prebuild && tsc",
+    "start": "node dist/index.js",
+    "dev": "nodemon",
+    "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\" \"libs/**/*.ts\"",
+    "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:cov": "jest --coverage",
+    "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
+    "test:e2e": "jest --config ./test/jest-e2e.json"
+  },
+  "devDependencies": {
+    "eslint": "^7.30.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-prettier": "^3.4.0",
+    "jest": "^27.0.6",
+    "nodemon": "^2.0.12",
+    "prettier": "^2.3.2"
+  }
+}

example/01-express-example/src/api/auth/index.js

@@ -0,0 +1,11 @@
+const express = require("express");
+
+const app = express.Router();
+
+app.get('/', function (req, res) {
+  return res.send('Hello World');
+});
+
+module.exports = {
+  authRouter: app
+}

example/01-express-example/src/api/users/index.js

@@ -0,0 +1,11 @@
+const express = require('express');
+
+const app = express.Router();
+
+app.get('/', function (req, res) {
+  return res.send('Hello World');
+});
+
+module.exports = {
+  userRouter: app
+}

example/01-express-example/src/index.js

@@ -0,0 +1,16 @@
+const express = require("express");
+const swaggerConfig = require("./swagger.config.js");
+const { authRouter } = require("./api/auth");
+const { userRouter } = require("./api/users");
+
+const app = express();
+const PORT = 3000;
+
+app.use('/api/v1/auth', authRouter);
+app.use('/api/v1/users', userRouter);
+
+swaggerConfig(app);
+
+app.listen(PORT, () => {
+  console.log(`App is running on port ${PORT}`);
+});

example/01-express-example/src/swagger.config.js

@@ -0,0 +1,25 @@
+const { DocumentBuilder } = require('../../../lib/api/core/document');
+const { setup, serve } = require("swagger-ui-express");
+
+module.exports = (app) => {
+  const document = new DocumentBuilder()
+    .setInfo({
+      title: 'Express application',
+      version: '1.0',
+      // Below fields are optional
+      description: 'Description',
+      termsOfService: 'http://swagger.io/terms/',
+      contact: {
+        name: 'Phu',
+        email: '[email protected]',
+      },
+      license: {
+        name: 'Apache 2.0',
+        url: 'http://www.apache.org/licenses/LICENSE-2.0.html',
+      },
+    })
+    .setBearerAuth()
+    .build();
+
+    app.use('/docs', serve, setup(document));
+};