feat: added Swagger UI integration

AliceO2Group · May 10, 2020 · 679b153 · 679b153
1 parent bd446e0
commit 679b153
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 16 deletions.
diff --git a/lib/server/index.js b/lib/server/index.js
@@ -13,6 +13,8 @@
 
 const path = require('path');
 const { HttpServer } = require('@aliceo2/web-ui');
+const swaggerUi = require('swagger-ui-express');
+const YAML = require('yamljs');
 const { IServer } = require('../application/interfaces');
 const buildEndpoints = require('./routers');
 
@@ -57,6 +59,10 @@ class WebUiServer extends IServer {
         }));
 
         buildEndpoints(this.http);
+
+        const swaggerDocument = YAML.load(path.resolve(__dirname, '..', '..', 'spec', 'openapi.yaml'));
+        this.http.routerStatics.use('/api-docs', swaggerUi.serve);
+        this.http.routerStatics.get('/api-docs', swaggerUi.setup(swaggerDocument));
     }
 
     /**

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -21,7 +21,9 @@
     "mariadb": "2.3.1",
     "sequelize": "5.21.8",
     "structure": "2.0.0",
-    "umzug": "2.3.0"
+    "swagger-ui-express": "4.1.4",
+    "umzug": "2.3.0",
+    "yamljs": "0.3.0"
   },
   "devDependencies": {
     "chai": "4.2.0",