serve openapi spec to allow download

chgeo · Sep 4, 2024 · 5ca93dc · 5ca93dc
1 parent f368090
commit 5ca93dc
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 8 deletions.
diff --git a/lib/middleware.js b/lib/middleware.js
@@ -21,13 +21,19 @@ module.exports = (options={}, swaggerUiOptions={}) => {
   cds.on('serving', service => {
     const apiPath = options.basePath + service.path
     const mount = apiPath.replace('$', '[\\$]')
+    const openapiPath = apiPath + '/openapi.json'
     debug?.('serving Swagger UI for', { service: service.name, at: apiPath })
 
-    const uiOptions = Object.assign({ customSiteTitle: `${service.name} - Swagger UI` }, swaggerUiOptions)
+    const uiOptions = Object.assign({ 
+      customSiteTitle: `${service.name} - Swagger UI`,
+      swaggerUrl: openapiPath
+    }, swaggerUiOptions)
+    router.get(mount+'/openapi.json', function (req, res) {
+      res.json(toOpenApiDoc(service, options))
+    })
     router.use(mount, (req, _, next) => {
-      req.swaggerDoc = toOpenApiDoc(service, options)
       next()
-    }, swaggerUi.serveFiles(), swaggerUi.setup(null, uiOptions))
+    }, swaggerUi.serveFiles(null, uiOptions), swaggerUi.setup(null, uiOptions))
 
     addLinkToIndexHtml(service, apiPath)
   })

diff --git a/tests/server.test.js b/tests/server.test.js
@@ -14,7 +14,7 @@ describe.only('Swagger UI', ()=>{
   })
   test('Diagram', async()=>{
     const { data } = await GET `/$api-docs/browse/swagger-ui-init.js`
-    expect (data) .to.contain('yuml')
+    expect (data) .to.contain('swaggerUrl')
   })
   test('preview link in index.html', async()=>{
     const { data } = await GET `/`
@@ -28,11 +28,13 @@ describe.only('Swagger UI', ()=>{
   })
 
   test('multiple services', async()=>{
-    let data  = (await GET `/$api-docs/browse/swagger-ui-init.js`).data
-    expect (data ) .to.be.a('string').that.contains('CatalogService')
+    let data  = (await GET `/$api-docs/browse/openapi.json`).data
+    expect (data ) .to.be.a('object').to.have.property('openapi')
+    expect (data ) .to.be.a('object').to.have.property('x-sap-shortText', 'Service for namespace CatalogService')
 
-    data  = (await GET `/$api-docs/admin/swagger-ui-init.js`).data
-    expect (data ) .to.be.a('string').that.contains('AdminService')
+    data  = (await GET `/$api-docs/admin/openapi.json`).data
+    expect (data ) .to.be.a('object').to.have.property('openapi')
+    expect (data ) .to.be.a('object').to.have.property('x-sap-shortText', 'Service for namespace AdminService')
   })
 
 })