Merge branch 'feature/activity' into 'dev'

swagger implementation for dashboard clockout route

See merge request hub-admins/attendance-management-backend!7

App/Providers/SwaggerServiceProvider.ts

@@ -0,0 +1,26 @@
+"use strict";
+import ServiceProvider from "Elucidate/Support/ServiceProvider";
+import swaggerUI from "swagger-ui-express";
+import swaggerJsDoc from "swagger-jsdoc";
+import options = require("../../swagger.json");
+
+class SwaggerServiceProvider extends ServiceProvider {
+  /**
+   * Register application services.
+   */
+  register() {
+    //
+  }
+
+  /**
+   * Bootstrap any application services.
+   * @return void
+   */
+  boot() {
+    let app = this.app.use("Application");
+    let specs = swaggerJsDoc(options);
+    app.use("/api-docs", swaggerUI.serve, swaggerUI.setup(specs));
+  }
+}
+
+export default SwaggerServiceProvider;

Config/app.ts

@@ -80,6 +80,7 @@ export default {
      */
     "App/Providers/AppServiceProvider::class",
     "App/Providers/RouteServiceProvider::class",
+    "App/Providers/SwaggerServiceProvider::class",
     //"App/Providers/SocketServiceProvider::class",
   ],
 };

package.json

@@ -21,6 +21,8 @@
     "@types/mongoose-paginate": "^5.0.8",
     "@types/node": "^14.14.17",
     "@types/nodemailer": "^6.4.2",
+    "@types/swagger-jsdoc": "^6.0.0",
+    "@types/swagger-ui-express": "^4.1.2",
     "jest": "^26.6.3",
     "nodemon": "^2.0.6",
     "rimraf": "^3.0.2",
@@ -47,6 +49,8 @@
     "mysql2": "^2.2.5",
     "node-mailer": "^0.1.1",
     "nodemailer": "^6.6.1",
-    "socket.io": "^3.1.0"
+    "socket.io": "^3.1.0",
+    "swagger-jsdoc": "^6.1.0",
+    "swagger-ui-express": "^4.1.6"
   }
 }

swagger.json

@@ -0,0 +1,24 @@
+{
+    "definition": {
+      "openapi": "3.0.n",
+      "info": {
+        "title": "Attendance System API Documentation",
+        "version": "0.1.0",
+        "description":
+          "Attendance System API docs with ExpressWebJs and documented with Swagger",
+        "license": {
+          "name": "MIT",
+          "url": "https://spdx.org/licenses/MIT.html"
+        },
+        "contact": {
+          "name": ""
+        }
+      },
+      "servers": [
+        {
+          "url": "http://localhost:5100/api"
+        }
+      ]
+    },
+    "apis": ["./Docs/*.ts"]
+  }

tsconfig.json

@@ -12,5 +12,7 @@
       "Utils/*":["./Utils/*"],
       "Elucidate/*":["./node_modules/expresswebcorets/lib/*"],
     },
+    "resolveJsonModule": true,
+    "esModuleInterop": true,
   }
 }