feat: Enable use of CDN

wesleytodd · Oct 18, 2024 · 2a04d87 · 2a04d87
1 parent e3b4d2f
commit 2a04d87
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 5 deletions.
diff --git a/lib/ui.js b/lib/ui.js
@@ -3,7 +3,7 @@ const path = require('path')
 const serve = require('serve-static')
 
 module.exports.serveSwaggerUI = function serveSwaggerUI (documentUrl, opts = {}) {
-  const { plugins, ...options } = opts
+  const { plugins, cdnBaseUrl, ...options } = opts
 
   return [serve(path.resolve(require.resolve('swagger-ui-dist'), '..'), { index: false }),
     function returnUiInit (req, res, next) {
@@ -24,12 +24,12 @@ module.exports.serveSwaggerUI = function serveSwaggerUI (documentUrl, opts = {})
     },
     function renderSwaggerHtml (req, res) {
       res.type('html').send(renderHtmlPage('Swagger UI', `
-      <link rel="stylesheet" type="text/css" href="./swagger-ui.css" >
+      <link rel="stylesheet" type="text/css" href="${cdnBaseUrl ?? '.'}/swagger-ui.css" >
     `, `
       <div id="swagger-ui"></div>
-      <script src="./swagger-ui-bundle.js"></script>
-      <script src="./swagger-ui-standalone-preset.js"></script>
-      <script src="./swagger-ui-init.js"></script>
+      <script src="${cdnBaseUrl ?? '.'}/swagger-ui-bundle.js"></script>
+      <script src="${cdnBaseUrl ?? '.'}/swagger-ui-standalone-preset.js"></script>
+      <script src="${cdnBaseUrl ?? '.'}/swagger-ui-init.js"></script>
     `))
     }
   ]

diff --git a/test/index.js b/test/index.js
@@ -653,6 +653,26 @@ suite(name, function () {
       })
   })
 
+  test('use a CDN', (done) => {
+    const app = express()
+    const oapi = openapi(undefined, { basePath: '/base-path' })
+
+    app.use(oapi)
+
+    app.get(oapi.routePrefix, oapi.swaggerui({ cdnBaseUrl: 'https://notARealURL' }))
+
+    supertest(app)
+      .get(oapi.routePrefix)
+      .expect(200, (err, res) => {
+        assert(!err, err)
+        assert(res.text.includes('<link rel="stylesheet" type="text/css" href="https://notARealURL/swagger-ui.css" >'))
+        assert(res.text.includes('<script src="https://notARealURL/swagger-ui-bundle.js"></script>'))
+        assert(res.text.includes('<script src="https://notARealURL/swagger-ui-standalone-preset.js"></script>'))
+        assert(res.text.includes('<script src="https://notARealURL/swagger-ui-init.js"></script>'))
+        done()
+      })
+  })
+
   // Other tests
   require('./_validate')()
   require('./_routes')()