Feat: Set API Docs (#25)

* set api docs * change title * add feature flag * add swagger path config Co-authored-by: BagusAK95 <[email protected]>
kata-ai · Apr 19, 2021 · 566e0ad · 566e0ad
1 parent 6ba2d4e
commit 566e0ad
Show file tree

Hide file tree

Showing 3 changed files with 5,068 additions and 38 deletions.
diff --git a/index.js b/index.js
@@ -4,6 +4,8 @@ const express = require("express");
 const bodyParser = require("body-parser");
 const router = require("./lib/router");
 const getfn = require("./lib/getfn");
+const swaggerJsdoc = require('swagger-jsdoc');
+const swaggerUi = require('swagger-ui-express');
 
 module.exports = function (merapi) {
 
@@ -26,6 +28,22 @@ module.exports = function (merapi) {
                 let bodyParserOptions = cfg.bodyParser || {};
                 let middleware = cfg.middleware || [];
                 let routes = cfg.routes || {};
+                let swaggerEnable = (cfg.swagger && cfg.swagger.enable) ? cfg.swagger.enable : false
+                if (swaggerEnable) {
+                    let swaggerPath = cfg.swagger.path || '/api-docs';
+                    let swaggerInfo = cfg.swagger.info || {
+                        title: 'API Documentation',
+                        version: '1.0.0',
+                    };
+                    let swaggerSpec = swaggerJsdoc({
+                        definition: {
+                          openapi: '3.0.0',
+                          info: swaggerInfo,
+                        },
+                        apis: ['./components/controllers/*_controller.ts', './components/managers/*_manager.ts', './components/swagger/*.yaml'],
+                    });
+                    app.use(swaggerPath, swaggerUi.serve, swaggerUi.setup(swaggerSpec));
+                }
 
                 if (bodyParserOptions.verify) {
                     bodyParserOptions.verify = yield getFn(bodyParserOptions.verify);