:sparkles: swagger docs | lots of comments | refactoring around plugins

backend/config/dev.js

@@ -0,0 +1,13 @@
+const config = {
+    /** Server info */
+    host: 'localhost',
+    port: 3001,
+
+    /** URL preceding endpoints */
+    apiBase: 'api',
+
+    /** Uncomment for cross-origin */
+    corsSupported: false
+}
+
+export { config }

backend/package.json

@@ -10,7 +10,10 @@
   "author": "TOJ",
   "license": "UNLICENSED",
   "dependencies": {
-    "@hapi/hapi": "^20.1.3"
+    "@hapi/hapi": "^20.1.3",
+    "hapi-swaggered": "^3.0.2",
+    "hapi-swaggered-ui": "^3.1.0",
+    "joi": "^13.7.0"
   },
   "devDependencies": {
     "nodemon": "^2.0.7"

backend/src/docs.js

@@ -0,0 +1,28 @@
+import hapiSwaggered from 'hapi-swaggered'
+import hapiSwaggeredUI from 'hapi-swaggered-ui'
+
+// ?: hapi-swaggered deps
+import vision from 'vision'
+import inert from 'inert'
+
+const swaggered = {
+    plugin: hapiSwaggered,
+    options: {},
+    info: {
+        title: 'EXAMPLE',
+        descrioption: 'just a test',
+        version: '1.0.0'
+    }
+}
+
+const swaggeredUI = {
+    plugin: hapiSwaggeredUI,
+    options: {
+        path: '/docs',
+        swaggerOptions: {
+            validatorUrl: null
+        },
+    }
+}
+
+export default [ vision, inert, swaggered, swaggeredUI ]

backend/src/handlers/index.js

@@ -1,5 +1,8 @@
-import { profile } from './profile.js'
-
+/** 
+ * Your default handlers
+ * NOT to be confused with per
+ * plugin HTTP handlers
+ */
 const handlers = {
     default: {
         get: (request, h) => {
@@ -9,8 +12,7 @@ const handlers = {
                 data: {}
             }
         }
-    },
-    profile
+    }
 }
 
 export { handlers }

backend/src/index.js

@@ -1,13 +1,19 @@
 import Hapi from '@hapi/hapi'
 
-import { routes } from './routes.js'
+import { routes } from './routes/index.js'
 import { plugins } from './plugins/index.js'
 
+import docs from './docs.js'
+
+import { config } from '../config/dev.js'
+
 const server = Hapi.server({
-    port: 3001,
-    host: 'localhost',
-    routes: { cors: true }
-});
+    port: config.port,
+    host: config.host,
+    routes: { 
+        cors: config.corsSupported
+    }
+})
 
 const init = async () => {
     try {
@@ -15,24 +21,26 @@ const init = async () => {
 
         for(const plugin of plugins) {
             await server.register(plugin, {
-                routes: { prefix: '/plugins' }
+                routes: { prefix: `/${config.apiBase}` }
             })
         }
+        
+        await server.register(docs)
 
         await server.start();
-        console.log('Server running on %s', server.info.uri);
+        console.log('\n[SIIMEE API] Server running on %s', server.info.uri)
     }
 
     catch(err) {
-        console.error(err);
+        console.error(err)
     }
 
 };
 
 process.on('unhandledRejection', (err) => {
-    console.log(err);
-    process.exit(1);
-});
+    console.log(err)
+    process.exit(1)
+})
 
 init()
 

backend/src/plugins/index.js

@@ -1,4 +1,4 @@
-import { profilePlugin } from './profile.js'
+import { profilePlugin } from './profile/index.js'
 import { testPlugin } from './test.js'
 
 const plugins = [ testPlugin, profilePlugin ]

backend/src/plugins/profile.js

@@ -1,15 +0,0 @@
-import { handlers } from '../handlers/index.js'
-
-const profilePlugin = {
-    name: 'profile-plugin',
-    version: '1.0.0',
-    register: async (server, options) => {
-        server.route({
-            method: 'GET',
-            path: '/profile',
-            handler: handlers.profile.get
-        })
-    }
-}
-
-export { profilePlugin }

backend/src/handlers/profile.js → backend/src/plugins/profile/handlers.js

@@ -1,22 +1,19 @@
 // https://github.com/connor11528/task-app-backend/blob/master/src/api/index.js
 
-const profile = {
+const handlers = {
     get: (request, h) => {
         try {
-            console.log('get handler for profile');
-
-            // You have to return SOMETHING
             return { 
                 ok: true,
                 handler: 'profile',
-                data: { name: 'Chuck Charles' },
+                data: { name: request.params.name },
             }
+        }
 
-        } 
         catch (err) {
             //   Boom.badImplementation(err);
         }
     }
 }
 
-export { profile }
+export { handlers }

backend/src/plugins/profile/index.js

@@ -0,0 +1,44 @@
+import { responses } from './responses.js'
+
+/**
+ * Swagger Descriptions
+ * Keys should match HTTP methods
+ * GET, PATCH, PUT, DELETE
+ * @param {string} description: Describe the endpoint
+ * @param {string} notes: What to expect as a return
+ */
+const descriptions = {
+    'GET': {
+        description: 'Profile endpoint returns junk',
+        notes: 'There\'s a lot we don\'nt know about yet'
+    }
+}
+
+/** Profile plugin ready for export */
+const profilePlugin = {
+    name: 'profile-plugin',
+    version: '1.0.0',
+
+    /**
+     * Register each HTTP response type
+     * Adds Swagger descriptions, response validations,
+     * and path validations all in one
+     * @param {object} responses - configs for all responses
+     */
+    register: async (server, options) => { 
+        Object.values(responses).forEach(res => {
+            
+            /** 
+             * Copy our response config and
+             * sprinkle endpoint docs
+             */
+            res.options = { 
+                ...descriptions[res.method],
+                ...res.options
+            }
+            server.route(res)
+        })
+    }
+}
+
+export { profilePlugin }

backend/src/plugins/profile/responses.js

@@ -0,0 +1,22 @@
+import { validators } from './validators.js'
+import { handlers } from './handlers.js'
+
+const responses = {
+    get: {
+        method: 'GET',
+        path: '/profile/{name}',
+        handler: handlers.get,
+        options: { 
+            tags: ['api'],
+            validate: {
+                params: validators.params
+            },
+            response: {
+                schema: validators.resSchema,
+                failAction: 'log'
+            }
+        }
+    }
+}
+
+export { responses }

backend/src/plugins/profile/validators.js

@@ -0,0 +1,15 @@
+import Joi from 'Joi'
+
+const validators = {
+    params: Joi.object({
+        name: Joi.string().min(3).max(11)
+    })
+}
+
+validators.resSchema = Joi.object({
+    ok: Joi.bool(),
+    handler: Joi.string(),
+    data: validators.params
+})
+
+export { validators }

backend/src/routes.js → backend/src/routes/index.js

@@ -1,4 +1,4 @@
-import { handlers } from './handlers/index.js'
+import { handlers } from '../handlers/index.js'
 
 const routes = [
     {