swagger-ui-express - npm Package Compare versions

Comparing version 2.0.3 to 2.0.4

index.js

@@ -10,3 +10,3 @@ 'use strict'
 
-var setup = function(swaggerDoc, explorer, options, customCss, customfavIcon) {
+var setup = function(swaggerDoc, explorer, options, customCss, customfavIcon, swaggerUrl) {
 	options = options || {};
@@ -22,3 +22,3 @@ var explorerString = explorer ?  '' : '.swagger-ui .topbar .download-url-wrapper { display: none }';
     }
-    var htmlWithSwaggerReplaced = html.toString().replace('<% swaggerDoc %>', JSON.stringify(swaggerDoc));
+    var htmlWithSwaggerReplaced = html.toString().replace('<% swaggerDoc %>', swaggerDoc ? JSON.stringify(swaggerDoc) : 'undefined');
     var favIconString = customfavIcon ? '<link rel="icon" href="' + customfavIcon + '" />' : favIconHtml;
@@ -28,4 +28,5 @@ var indexHTML = htmlWithSwaggerReplaced.replace('<% customOptions %>', stringify(options))
     var htmlWithFavIcon  = htmlWithCustomCss.replace('<% favIconString %>', favIconString);
+    var htmlWithSwaggerUrl = htmlWithFavIcon.replace('<% swaggerUrl %>', swaggerUrl ? '"' + swaggerUrl + '"' : 'undefined')
 
-    return function(req, res) { res.send(htmlWithFavIcon) };
+    return function(req, res) { res.send(htmlWithSwaggerUrl) };
 };
@@ -32,0 +33,0 @@

package.json

 {
   "name": "swagger-ui-express",
-  "version": "2.0.3",
+  "version": "2.0.4",
   "description": "Swagger UI Express",
@@ -5,0 +5,0 @@ "main": "./lib/index.js",

README.md

@@ -90,2 +90,17 @@ # Swagger UI Express
 
+### Load swagger from url
+
+To load your swagger from a url instead of injecting the document, pass `null` as the first parameter, and pass the relative or absolute URL as the sixth parameter.
+
+```javascript
+const express = require('express');
+const app = express();
+const swaggerUi = require('swagger-ui-express');
+
+const swaggerDocument = require('./swagger.json');
+
+app.static
+app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(null, null, null, null, null, 'http://petstore.swagger.io/v2/swagger.json'));
+```
+
 ## Requirements
@@ -92,0 +107,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1865677

increased by0.04%

Lines of code

7205

increased by0.01%

Number of lines in readme file

115

increased by15%

No dependency changes