upgrade to swagger ui 3

scttcper · Mar 21, 2017 · 65dd02f · 65dd02f
1 parent 2999fde
commit 65dd02f
Show file tree

Hide file tree

Showing 18 changed files with 405 additions and 3,019 deletions.
diff --git a/examples/example.js b/examples/example.js
@@ -1,7 +1,8 @@
 const Koa = require('koa');
 const koaSwagger = require('../lib/');
 
-const app = module.exports = new Koa();
+const app = new Koa();
+module.exports = app;
 
 app.use(koaSwagger());
 

diff --git a/lib/index.hbs b/lib/index.hbs
@@ -0,0 +1,89 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>{{title}}</title>
+  <link href="https://fonts.googleapis.com/css?family=Open+Sans:400,700|Source+Code+Pro:300,600|Titillium+Web:400,600,700" rel="stylesheet">
+  <link rel="stylesheet" type="text/css" href="{{routePrefix}}/swagger-ui.css" >
+  <link rel="icon" type="image/png" href="favicon-32x32.png" sizes="32x32" />
+  <link rel="icon" type="image/png" href="favicon-16x16.png" sizes="16x16" />
+  <style>
+    html
+    {
+        box-sizing: border-box;
+        overflow: -moz-scrollbars-vertical;
+        overflow-y: scroll;
+    }
+    *,
+    *:before,
+    *:after
+    {
+        box-sizing: inherit;
+    }
+
+    body {
+      margin:0;
+      background: #fafafa;
+    }
+  </style>
+</head>
+
+<body>
+
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="position:absolute;width:0;height:0">
+  <defs>
+    <symbol viewBox="0 0 20 20" id="unlocked">
+          <path d="M15.8 8H14V5.6C14 2.703 12.665 1 10 1 7.334 1 6 2.703 6 5.6V6h2v-.801C8 3.754 8.797 3 10 3c1.203 0 2 .754 2 2.199V8H4c-.553 0-1 .646-1 1.199V17c0 .549.428 1.139.951 1.307l1.197.387C5.672 18.861 6.55 19 7.1 19h5.8c.549 0 1.428-.139 1.951-.307l1.196-.387c.524-.167.953-.757.953-1.306V9.199C17 8.646 16.352 8 15.8 8z"></path>
+    </symbol>
+
+    <symbol viewBox="0 0 20 20" id="locked">
+      <path d="M15.8 8H14V5.6C14 2.703 12.665 1 10 1 7.334 1 6 2.703 6 5.6V8H4c-.553 0-1 .646-1 1.199V17c0 .549.428 1.139.951 1.307l1.197.387C5.672 18.861 6.55 19 7.1 19h5.8c.549 0 1.428-.139 1.951-.307l1.196-.387c.524-.167.953-.757.953-1.306V9.199C17 8.646 16.352 8 15.8 8zM12 8H8V5.199C8 3.754 8.797 3 10 3c1.203 0 2 .754 2 2.199V8z"/>
+    </symbol>
+
+    <symbol viewBox="0 0 20 20" id="close">
+      <path d="M14.348 14.849c-.469.469-1.229.469-1.697 0L10 11.819l-2.651 3.029c-.469.469-1.229.469-1.697 0-.469-.469-.469-1.229 0-1.697l2.758-3.15-2.759-3.152c-.469-.469-.469-1.228 0-1.697.469-.469 1.228-.469 1.697 0L10 8.183l2.651-3.031c.469-.469 1.228-.469 1.697 0 .469.469.469 1.229 0 1.697l-2.758 3.152 2.758 3.15c.469.469.469 1.229 0 1.698z"/>
+    </symbol>
+
+    <symbol viewBox="0 0 20 20" id="large-arrow">
+      <path d="M13.25 10L6.109 2.58c-.268-.27-.268-.707 0-.979.268-.27.701-.27.969 0l7.83 7.908c.268.271.268.709 0 .979l-7.83 7.908c-.268.271-.701.27-.969 0-.268-.269-.268-.707 0-.979L13.25 10z"/>
+    </symbol>
+
+    <symbol viewBox="0 0 20 20" id="large-arrow-down">
+      <path d="M17.418 6.109c.272-.268.709-.268.979 0s.271.701 0 .969l-7.908 7.83c-.27.268-.707.268-.979 0l-7.908-7.83c-.27-.268-.27-.701 0-.969.271-.268.709-.268.979 0L10 13.25l7.418-7.141z"/>
+    </symbol>
+
+
+    <symbol viewBox="0 0 24 24" id="jump-to">
+      <path d="M19 7v4H5.83l3.58-3.59L8 6l-6 6 6 6 1.41-1.41L5.83 13H21V7z"/>
+    </symbol>
+
+    <symbol viewBox="0 0 24 24" id="expand">
+      <path d="M10 18h4v-2h-4v2zM3 6v2h18V6H3zm3 7h12v-2H6v2z"/>
+    </symbol>
+
+  </defs>
+</svg>
+
+<div id="swagger-ui"></div>
+
+<script src="{{routePrefix}}/swagger-ui-bundle.js"> </script>
+<script src="{{routePrefix}}/swagger-ui-standalone-preset.js"> </script>
+<script>
+window.onload = function() {
+  const options = {{{json swaggerOptions}}};
+  options.presets = [
+    SwaggerUIBundle.presets.apis,
+    // yay ES6 modules ↘
+    Array.isArray(SwaggerUIStandalonePreset) ? SwaggerUIStandalonePreset : SwaggerUIStandalonePreset.default
+  ];
+  options.plugins = [
+    SwaggerUIBundle.plugins.DownloadUrl
+  ];
+  // Build a system
+  const ui = SwaggerUIBundle(options)
+  window.ui = ui
+}
+</script>
+</body>
+
+</html>
diff --git a/lib/index.js b/lib/index.js
@@ -2,37 +2,34 @@ const path = require('path');
 const fs = require('fs');
 const defaultsDeep = require('lodash.defaultsdeep');
 const send = require('koa-send');
-const swaggerUiPath = require('swagger-ui/index').dist;
 const Handlebars = require('handlebars');
 
+const rootPath = path.join(__dirname, '../public');
+
 const defaultOptions = {
-  title: 'swagger',
+  title: 'Swagger UI',
   oauthOptions: {},
   swaggerOptions: {
-    dom_id: 'swagger-ui-container',
+    dom_id: '#swagger-ui',
     url: 'http://petstore.swagger.io/v2/swagger.json',
-    supportedSubmitMethods: ['get', 'post', 'put', 'delete', 'patch'],
-    docExpansion: 'none',
-    jsonEditor: false,
-    defaultModelRendering: 'schema',
-    showRequestHeaders: false,
+    layout: 'StandaloneLayout',
   },
   routePrefix: '/docs',
 };
 
 module.exports = function koaSwagger(config) {
   const options = defaultsDeep(config || {}, defaultOptions);
   Handlebars.registerHelper('json', context => JSON.stringify(context));
-  const index = Handlebars.compile(fs.readFileSync(path.join(__dirname, '../templates/index.hbs'), 'utf-8'));
+  const index = Handlebars.compile(fs.readFileSync(path.join(__dirname, './index.hbs'), 'utf-8'));
 
-  return (ctx, next) => {
+  return function koaSwaggerUi(ctx, next) {
     if (ctx.path === options.routePrefix) {
       ctx.type = 'text/html';
       ctx.body = index(options);
       return next();
     } else if (ctx.path.indexOf(options.routePrefix) === 0) {
       const truePath = ctx.path.substring(options.routePrefix.length, ctx.path.length);
-      return send(ctx, truePath, { root: swaggerUiPath });
+      return send(ctx, truePath, { root: rootPath });
     }
     return next();
   };

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "koa2-swagger-ui",
-  "version": "1.0.3",
+  "version": "2.0.0",
   "description": "Swagger UI middleware for koa",
   "main": "lib/index.js",
   "scripts": {
@@ -11,22 +11,22 @@
   "dependencies": {
     "handlebars": "^4.0.6",
     "koa-send": "^3.3.0",
-    "lodash.defaultsdeep": "^4.6.0",
-    "swagger-ui": "^2.2.10"
+    "lodash.defaultsdeep": "^4.6.0"
   },
   "peerDependencies": {
-    "koa": "^2.1.0"
+    "koa": "^2.2.0"
   },
   "devDependencies": {
-    "eslint": "^3.17.1",
+    "eslint": "^3.18.0",
     "eslint-config-airbnb-base": "^11.1.1",
     "eslint-plugin-import": "^2.2.0",
-    "koa": "^2.1.0",
+    "koa": "^2.2.0",
     "mocha": "^3.2.0",
     "mocha-eslint": "^3.0.1",
     "nodemon": "^1.11.0",
     "nyc": "^10.1.2",
-    "supertest": "^3.0.0"
+    "supertest": "^3.0.0",
+    "swagger-ui": "^3.0.2"
   },
   "nyc": {
     "reporter": [

diff --git a/public/favicon-16x16.png b/public/favicon-16x16.png
diff --git a/public/favicon-32x32.png b/public/favicon-32x32.png
diff --git a/public/index.html b/public/index.html
@@ -0,0 +1,92 @@
+<!DOCTYPE html>
+<!-- this is for the dev server -->
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>Swagger UI</title>
+  <link href="https://fonts.googleapis.com/css?family=Open+Sans:400,700|Source+Code+Pro:300,600|Titillium+Web:400,600,700" rel="stylesheet">
+  <style>
+    html
+    {
+        box-sizing: border-box;
+        overflow: -moz-scrollbars-vertical;
+        overflow-y: scroll;
+    }
+    *,
+    *:before,
+    *:after
+    {
+        box-sizing: inherit;
+    }
+
+    body {
+      margin:0;
+      background: #fafafa;
+    }
+  </style>
+</head>
+
+<body>
+
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="position:absolute;width:0;height:0">
+  <defs>
+    <symbol viewBox="0 0 20 20" id="unlocked">
+          <path d="M15.8 8H14V5.6C14 2.703 12.665 1 10 1 7.334 1 6 2.703 6 5.6V6h2v-.801C8 3.754 8.797 3 10 3c1.203 0 2 .754 2 2.199V8H4c-.553 0-1 .646-1 1.199V17c0 .549.428 1.139.951 1.307l1.197.387C5.672 18.861 6.55 19 7.1 19h5.8c.549 0 1.428-.139 1.951-.307l1.196-.387c.524-.167.953-.757.953-1.306V9.199C17 8.646 16.352 8 15.8 8z"></path>
+    </symbol>
+
+    <symbol viewBox="0 0 20 20" id="locked">
+      <path d="M15.8 8H14V5.6C14 2.703 12.665 1 10 1 7.334 1 6 2.703 6 5.6V8H4c-.553 0-1 .646-1 1.199V17c0 .549.428 1.139.951 1.307l1.197.387C5.672 18.861 6.55 19 7.1 19h5.8c.549 0 1.428-.139 1.951-.307l1.196-.387c.524-.167.953-.757.953-1.306V9.199C17 8.646 16.352 8 15.8 8zM12 8H8V5.199C8 3.754 8.797 3 10 3c1.203 0 2 .754 2 2.199V8z"/>
+    </symbol>
+
+    <symbol viewBox="0 0 20 20" id="close">
+      <path d="M14.348 14.849c-.469.469-1.229.469-1.697 0L10 11.819l-2.651 3.029c-.469.469-1.229.469-1.697 0-.469-.469-.469-1.229 0-1.697l2.758-3.15-2.759-3.152c-.469-.469-.469-1.228 0-1.697.469-.469 1.228-.469 1.697 0L10 8.183l2.651-3.031c.469-.469 1.228-.469 1.697 0 .469.469.469 1.229 0 1.697l-2.758 3.152 2.758 3.15c.469.469.469 1.229 0 1.698z"/>
+    </symbol>
+
+    <symbol viewBox="0 0 20 20" id="large-arrow">
+      <path d="M13.25 10L6.109 2.58c-.268-.27-.268-.707 0-.979.268-.27.701-.27.969 0l7.83 7.908c.268.271.268.709 0 .979l-7.83 7.908c-.268.271-.701.27-.969 0-.268-.269-.268-.707 0-.979L13.25 10z"/>
+    </symbol>
+
+    <symbol viewBox="0 0 20 20" id="large-arrow-down">
+      <path d="M17.418 6.109c.272-.268.709-.268.979 0s.271.701 0 .969l-7.908 7.83c-.27.268-.707.268-.979 0l-7.908-7.83c-.27-.268-.27-.701 0-.969.271-.268.709-.268.979 0L10 13.25l7.418-7.141z"/>
+    </symbol>
+
+
+    <symbol viewBox="0 0 24 24" id="jump-to">
+      <path d="M19 7v4H5.83l3.58-3.59L8 6l-6 6 6 6 1.41-1.41L5.83 13H21V7z"/>
+    </symbol>
+
+    <symbol viewBox="0 0 24 24" id="expand">
+      <path d="M10 18h4v-2h-4v2zM3 6v2h18V6H3zm3 7h12v-2H6v2z"/>
+    </symbol>
+
+  </defs>
+</svg>
+
+<div id="swagger-ui"></div>
+
+<!-- don't be alarmed, these don't match what's in dist, because webpack-dev-server serves them in memory. -->
+<script src="/dist/SwaggerUIBundle.js"> </script>
+<script src="/dist/SwaggerUIStandalonePreset.js"> </script>
+<script>
+window.onload = function() {
+  // Build a system
+  const ui = SwaggerUIBundle({
+    url: "http://petstore.swagger.io/v2/swagger.json",
+    dom_id: '#swagger-ui',
+    presets: [
+      SwaggerUIBundle.presets.apis,
+      // yay ES6 modules ↘
+      Array.isArray(SwaggerUIStandalonePreset) ? SwaggerUIStandalonePreset : SwaggerUIStandalonePreset.default
+    ],
+    plugins: [
+      SwaggerUIBundle.plugins.DownloadUrl
+    ],
+    layout: "StandaloneLayout"
+  })
+
+  window.ui = ui
+}
+</script>
+</body>
+
+</html>
diff --git a/public/swagger-ui-bundle.js b/public/swagger-ui-bundle.js
diff --git a/public/swagger-ui-bundle.js.map b/public/swagger-ui-bundle.js.map
diff --git a/public/swagger-ui-standalone-preset.js b/public/swagger-ui-standalone-preset.js
diff --git a/public/swagger-ui-standalone-preset.js.map b/public/swagger-ui-standalone-preset.js.map
diff --git a/public/swagger-ui.css b/public/swagger-ui.css
diff --git a/public/swagger-ui.css.map b/public/swagger-ui.css.map
diff --git a/public/swagger-ui.js b/public/swagger-ui.js
diff --git a/public/swagger-ui.js.map b/public/swagger-ui.js.map