Merge pull request #115 from mateusbs17/master

Pchelolo · web-flow · commit 9c266703f8da · 2019-06-05T10:52:42.000+03:00
Use swagger-ui-dist instead of swagger-ui
diff --git a/.travis.yml b/.travis.yml
@@ -4,5 +4,4 @@ sudo: false
 
 node_js:
   - "6"
-  - "8"
-  - "node"
+  - "10"
diff --git a/app.js b/app.js
@@ -80,8 +80,8 @@ function initApp(options) {
             app.conf.spec = {};
         }
     }
-    if (!app.conf.spec.swagger) {
-        app.conf.spec.swagger = '2.0';
+    if (!app.conf.spec.openapi) {
+        app.conf.spec.openapi = '3.0.0';
     }
     if (!app.conf.spec.info) {
         app.conf.spec.info = {
diff --git a/lib/swagger-ui.js b/lib/swagger-ui.js
@@ -5,8 +5,8 @@ const fs = BBPromise.promisifyAll(require('fs'));
 const path = require('path');
 const HTTPError = require('../lib/util.js').HTTPError;
 
-// Swagger-ui helpfully exporting the absolute path of its dist directory
-const docRoot = `${require('swagger-ui').dist}/`;
+// Swagger-ui-dist helpfully exporting the absolute path of its dist directory
+const docRoot = `${require('swagger-ui-dist').getAbsoluteFSPath()}/`;
 
 function processRequest(app, req, res) {
 
@@ -27,25 +27,48 @@ function processRequest(app, req, res) {
     return fs.readFileAsync(filePath)
     .then((body) => {
         if (reqPath === '/index.html') {
+            const css = `
+                /* Removes Swagger's image from the header bar */
+                .topbar-wrapper .link img {
+                    display: none;
+                }
+                /* Adds the application's name in the header bar */
+                .topbar-wrapper .link::after {
+                    content: "${app.info.name}";
+                }
+                /* Removes input field and explore button from header bar */
+                .swagger-ui .topbar .download-url-wrapper {
+                    display: none;
+                }
+                /* Modifies the font in the information area */
+                .swagger-ui .info li, .swagger-ui .info p, .swagger-ui .info table, .swagger-ui .info a {
+                    font-size: 16px;
+                    line-height: 1.4em;
+                }
+                /* Removes authorize button and section */
+                .scheme-container {
+                    display: none
+                }
+            `;
             body = body.toString()
                 .replace(/((?:src|href)=['"])/g, '$1?doc&path=')
                 // Some self-promotion
-                .replace(/<a id="logo".*?<\/a>/,
-                    `<a id="logo" href="${app.info.homepage}">${app.info.name}</a>`)
+                .replace(/<\/style>/, `${css}\n  </style>`)
                 .replace(/<title>[^<]*<\/title>/, `<title>${app.info.name}</title>`)
                 // Replace the default url with ours, switch off validation &
                 // limit the size of documents to apply syntax highlighting to
-                .replace(/docExpansion: "none"/, 'docExpansion: "list", ' +
-                    'validatorUrl: null, ' +
-                    'highlightSizeThreshold: 10000')
-                .replace(/ url: url,/, 'url: "/?spec",');
+                .replace(/dom_id: '#swagger-ui'/, 'dom_id: "#swagger-ui", ' +
+                    'docExpansion: "none", defaultModelsExpandDepth: -1, validatorUrl: null, displayRequestDuration: true')
+                .replace(/"https:\/\/petstore.swagger.io\/v2\/swagger.json"/,
+                    '"/?spec"');
         }
 
         let contentType = 'text/html';
         if (/\.js$/.test(reqPath)) {
             contentType = 'text/javascript';
             body = body.toString()
-                .replace(/underscore-min\.map/, '?doc&path=lib/underscore-min.map');
+                .replace(/underscore-min\.map/, '?doc&path=lib/underscore-min.map')
+                .replace(/sourceMappingURL=/, 'sourceMappingURL=/?doc&path=');
         } else if (/\.png$/.test(reqPath)) {
             contentType = 'image/png';
         } else if (/\.map$/.test(reqPath)) {
@@ -54,11 +77,13 @@ function processRequest(app, req, res) {
             contentType = 'application/x-font-ttf';
         } else if (/\.css$/.test(reqPath)) {
             contentType = 'text/css';
-            body = body.toString().replace(/\.\.\/(images|fonts)\//g, '?doc&path=$1/');
+            body = body.toString()
+                .replace(/\.\.\/(images|fonts)\//g, '?doc&path=$1/')
+                .replace(/sourceMappingURL=/, 'sourceMappingURL=/?doc&path=');
         }
 
         res.setHeader('Content-Type', contentType);
-        res.setHeader('content-security-policy', "default-src 'none'; " +
+        res.setHeader('Content-Security-Policy', "default-src 'none'; " +
                         "script-src 'self' 'unsafe-inline'; connect-src *; " +
                         "style-src 'self' 'unsafe-inline'; img-src 'self'; font-src 'self';");
         res.send(body.toString());
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "service-template-node",
-  "version": "0.5.9",
+  "version": "0.6.0",
   "description": "A blueprint for MediaWiki REST API services",
   "main": "./app.js",
   "scripts": {
@@ -42,7 +42,7 @@
     "preq": "^0.5.6",
     "service-runner": "^2.6.4",
     "swagger-router": "^0.7.2",
-    "swagger-ui": "git+https://github.com/wikimedia/swagger-ui#master"
+    "swagger-ui-dist": "^3.22.1"
   },
   "devDependencies": {
     "ajv": "^6.5.4",
diff --git a/spec.template.yaml b/spec.template.yaml
diff --git a/test/features/app/spec.js b/test/features/app/spec.js

-Original file line number
+Diff line change
 node_js:
   - "6"
 -  - "8"
 -  - "node"
 +  - "10"
Original file line number	Diff line number	Diff line change
`@@ -80,8 +80,8 @@ function initApp(options) {`
`80`	`80`	`app.conf.spec = {};`
`81`	`81`	`}`
`82`	`82`	`}`
`83`		`- if (!app.conf.spec.swagger) {`
`84`		`- app.conf.spec.swagger = '2.0';`
	`83`	`+ if (!app.conf.spec.openapi) {`
	`84`	`+ app.conf.spec.openapi = '3.0.0';`
`85`	`85`	`}`
`86`	`86`	`if (!app.conf.spec.info) {`
`87`	`87`	`app.conf.spec.info = {`