feat: serve openapi.yaml file as documentation page

package.json

@@ -64,6 +64,7 @@
     "cors": "^2.8.5",
     "express": "^4.17.1",
     "js-yaml": "^4.1.0",
+    "redoc-express": "^1.0.0",
     "uuid": "^8.3.2",
     "winston": "^3.3.3"
   },

src/controllers/docs.controller.ts

@@ -0,0 +1,34 @@
+import { NextFunction, Request, Response, Router } from 'express';
+
+import redoc from 'redoc-express';
+
+import { Controller } from '../interfaces';
+
+export class DocsController implements Controller {
+  public basepath = '/docs';
+
+  private async docs(req: Request, res: Response, next: NextFunction) {
+    try { 
+
+      await redoc({
+        title: 'API Docs',
+        specUrl: '.../openapi.yaml'
+      });
+
+      res.status(204).end();
+    } catch (err) {
+      return next(err);
+    }
+  }
+
+  public boot(): Router {
+    const router = Router();
+
+    router.post(
+      `${this.basepath}`,
+      this.docs.bind(this)
+    );
+
+    return router;
+  }
+}

src/server.ts

@@ -7,9 +7,11 @@ process.env['NODE_CONFIG_DIR'] = `${__dirname  }/configs`;
 import { App } from './app';
 import { GenerateController } from './controllers/generate.controller';
 import { ValidateController } from './controllers/validate.controller';
+import { DocsController } from './controllers/docs.controller';
 
 const app = new App([
   new GenerateController(),
-  new ValidateController()
+  new ValidateController(),
+  new DocsController()
 ]);
 app.listen();