Merge 1213fdf into 93de2a7

package.json

@@ -15,7 +15,9 @@
   "dependencies": {
     "dotenv": "^8.0.0",
     "express": "^4.17.1",
-    "morgan": "^1.9.1"
+    "morgan": "^1.9.1",
+    "swagger-ui-express": "^4.0.7",
+    "yamljs": "^0.3.0"
   },
   "devDependencies": {
     "@babel/cli": "^7.5.5",

server/docs/authors-haven-api.yml

@@ -0,0 +1,40 @@
+openapi: 3.0.1
+
+info:
+  title: Authors Haven API Documentation
+  description: Create a community of like minded authors to foster inspiration and innovation by leveraging the modern web.
+  version: 1.0.0
+  contact:
+    email: teamrambo50@gmail.com
+
+license:
+  name: Apache 2.0
+  url: http://www.apache.org/licenses/LICENSE-2.0.html
+
+servers:
+  - url: /
+    desription: Localhost server
+  - url: https://authors-haven-development.herokuapp.com/
+    desription: Heroku development server
+
+paths:
+  /:
+    summary: Represent root of the application
+    description: Represent root of the application.
+    get:
+      summary: Returns a welcome message.
+      description: Returns a welcome message.
+      responses:
+        '200':
+          description: Success
+          content:
+            text/plain:
+              schema:
+                type: string
+                example: Welcome to Authors Haven
+
+components:
+  securitySchemes:
+    BearerAuth:
+      type: http
+      scheme: bearer

server/index.js

@@ -1,17 +1,24 @@
 import express, { json, urlencoded } from 'express';
 import logger from 'morgan';
 import { config } from 'dotenv';
+import swaggerUi from 'swagger-ui-express';
+import YAML from 'yamljs';
+import path from 'path';
 
 config();
 
 const { log } = console;
-
 const PORT = process.env.PORT || 9000;
 
 const app = express();
+const swaggerDoc = YAML.load(
+  path.join(__dirname, './docs/authors-haven-api.yml')
+);
+
 app.use(logger('dev'));
 app.use(json());
-app.use(urlencoded({ extended: false, }));
+app.use(urlencoded({ extended: false }));
+app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDoc));
 
 app.get('/', (request, response) => {
   response.status(200).send('Welcome to Authors Haven ');
@@ -20,5 +27,7 @@ app.get('/', (request, response) => {
 app.use('*', (request, response) => {
   response.status(404).send('Not Found');
 });
+
 app.listen(PORT, () => log(`Server started on port ${PORT}`));
+
 export default app;