feat(swagger): use swagger-ui-express to display simple and administration api doc

docker/distributions/debian/Dockerfile

@@ -43,6 +43,8 @@ COPY /docker/config /home/docker/config/
 ### Dossier de l'application
 WORKDIR /home/docker/app
 COPY src ./src/
+### Dossier documentation apis
+COPY documentation/apis ./documentation/apis
 ### Récupération des sources de l'application
 COPY *.json ./
 

package.json

@@ -26,7 +26,9 @@
     "https-proxy-agent": "5.0.1",
     "log4js": "6.7.1",
     "nconf": "0.12.0",
-    "proj4": "2.8.0"
+    "proj4": "2.8.0",
+    "swagger-ui-express": "4.6.3",
+    "yaml": "2.3.1"
   },
   "optionalDependencies": {
     "osrm": "5.26.0",
@@ -53,6 +55,8 @@
     "assert",
     "helmet",
     "got",
-    "http-proxy-agent"
+    "http-proxy-agent",
+    "swagger-ui-express",
+    "yaml"
   ]
 }

src/js/apis/simple/1.0.0/index.js

@@ -1,10 +1,14 @@
 'use strict';
 
 
+const fs = require('fs');
+const path = require('path');
 const express = require('express');
 const log4js = require('log4js');
 const controller = require('./controller/controller');
 const errorManager = require('../../../utils/errorManager');
+const swaggerUi = require('swagger-ui-express');
+const YAML = require('yaml')
 
 var LOGGER = log4js.getLogger("SIMPLE");
 var router = express.Router();
@@ -44,6 +48,14 @@ router.all("/", function(req, res) {
   res.send("Road2 via l'API simple 1.0.0");
 });
 
+
+// swagger-ui
+var apiYamlPath = path.join(__dirname, '..', '..', '..','..','..', 'documentation','apis','simple', '1.0.0', 'api.yaml')
+LOGGER.info("Utilisation fichier .yaml '"+ apiYamlPath + "' pour initialisation swagger-ui de l'API simple en version 1.0.0");
+var file  = fs.readFileSync(apiYamlPath, 'utf8')
+var swaggerDocument = YAML.parse(file)
+router.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));
+
 // GetCapabilities
 router.all("/getcapabilities", function(req, res) {