enable local development to serve open-api docs

Author: clairep94

common/openapi.yaml

@@ -1,4 +1,4 @@
-openapi: 3.0.4
+openapi: 3.1.0
 info:
   title: p5.js Web Editor - 1.11.10
   description: |-
@@ -15,7 +15,7 @@ externalDocs:
 servers:
   - url: https://editor.p5js.org
     description: Production server
-  - url: http://locationhost:8000
+  - url: http://localhost:8000
     description: Location development server
 tags:
   - name: Auth

package-lock.json

@@ -144,7 +144,6 @@
     "@types/nodemailer": "^7.0.1",
     "@types/nodemailer-mailgun-transport": "^1.4.6",
     "@types/passport": "^1.0.17",
-    "@types/passport": "^1.0.17",
     "@types/react": "^16.14.0",
     "@types/react-dom": "^16.9.25",
     "@types/react-router-dom": "^5.3.3",
@@ -306,10 +305,12 @@
     "stacktrace-js": "^2.0.2",
     "styled-components": "^5.3.0",
     "styled-theming": "^2.2.0",
+    "swagger-ui-express": "^5.0.1",
     "url": "^0.11.0",
     "uuid": "^8.3.2",
     "webpack": "^5.94.0",
     "webpack-dev-middleware": "^5.3.4",
-    "xhr": "^2.6.0"
+    "xhr": "^2.6.0",
+    "yamljs": "^0.3.0"
   }
 }

package.json

@@ -9,10 +9,15 @@ import passport from 'passport';
 import path from 'path';
 import basicAuth from 'express-basic-auth';
 
+// Swagger Open Api requirements:
+import swaggerUi from 'swagger-ui-express';
+import YAML from 'yamljs';
+
 // Webpack Requirements
 import webpack from 'webpack';
 import webpackDevMiddleware from 'webpack-dev-middleware';
 import webpackHotMiddleware from '@gatsbyjs/webpack-hot-middleware';
+
 import config from '../webpack/config.dev';
 
 // Import all required modules
@@ -32,6 +37,7 @@ import { renderIndex } from './views/index';
 import { get404Sketch } from './views/404Page';
 
 const app = new Express();
+const swaggerDocument = YAML.load('./common/openapi.yaml');
 
 app.get('/health', (req, res) => res.json({ success: true }));
 
@@ -55,6 +61,9 @@ if (process.env.NODE_ENV === 'development') {
     })
   );
   app.use(webpackHotMiddleware(compiler, { log: false }));
+
+  // Show swagger openapi docs in local development only?
+  app.use('/open-api', swaggerUi.serve, swaggerUi.setup(swaggerDocument));
 }
 
 const mongoConnectionString = process.env.MONGO_URL;