Inject - some middleware & swaggerUi

Author: sourabh

app.js

@@ -1,13 +1,33 @@
 require("dotenv").config();
-const express = require('express')
-const app = express()
+const express = require("express");
+const app = express();
+const cookieParser = require("cookie-parser");
+const fileUpload = require("express-fileupload");
 
-// Ref: ✈️🔗https://expressjs.com/en/5x/api.html#router
+//SWAGGER DOCUMENTATION
+const swaggerUi = require("swagger-ui-express");
+const fs = require("fs");
+const YAML = require("yamljs");
+const file = fs.readFileSync("./swagger.yaml", "utf8");
+const swaggerDocument = YAML.parse(file);
+app.use("/api-docs", swaggerUi.serve, swaggerUi.setup(swaggerDocument));
 
-// BRINGS ROUTES 
+//MORGAN MIDDLEWARE
+const morgan = require("morgan");
+app.use(morgan("tiny"));
+
+//COOKIES AND FILE-UPLOAD MIDDLEWARE
+app.use(cookieParser());
+app.use(fileUpload());
+
+//REGULAR MIDDLEWARE
+app.use(express.json());
+app.use(express.urlencoded({extended:true}))
+
+// BRINGS ROUTES
 const home = require("./routes/home");
 
 // USING MIDDLEWARE
-app.use("/api/v1",home);
+app.use("/api/v1", home);
 
-module.exports = app;
+module.exports = app;

map_project.js

@@ -0,0 +1,29 @@
+/*
+@ABOUT_ROUTES:
+Ref: ✈️🔗https://expressjs.com/en/5x/api.html#router
+
+-----------------NEW--------------------
+@SECTION:Injecting Docs and MIDDLEWARE
+@ABOUT: All about Inject MIDDLEWARE
+@TITLE:
+@LOCATION:🗃️App.js
+
+@OVERVIEW:->
+@REQUERE
+-🎗️Need Body-parser for handle JSON
+-🎗️Need cookie-parser,swagger,morgan
+
+@ABOUT_MORGAN
+Ref: ✈️🔗 https://www.npmjs.com/package/morgan
+SCROLL ON till Bottom ...above link
+😗@NOTE: NEEDs to be come befoure route it's convection
+
+@INVITE_&_INSTALL:-> MORGAN,cookieParser,fileUpload,swaggerUi & some REGULAR MIDDLEWARE like json & urlencoded 
+
+
+
+ 
+
+
+
+*/

nodemon.json

@@ -0,0 +1,3 @@
+{
+    "ext": ".js, .jsx, .yaml"
+}

package-lock.json

@@ -26,7 +26,9 @@
     "nodemailer": "^6.9.3",
     "razorpay": "^2.8.6",
     "stripe": "^12.10.0",
-    "validator": "^13.9.0"
+    "swagger-ui-express": "^4.6.3",
+    "validator": "^13.9.0",
+    "yamljs": "^0.3.0"
   },
   "devDependencies": {
     "nodemon": "^2.0.22"

package.json

@@ -0,0 +1,56 @@
+openapi: 3.0.0
+info:
+  title: Tshirt store API
+  description: A course to create API for ecomm store
+  version: 1.1.0
+  contact:
+    email: sp647600@gmail.com
+    url: "https://saurabh-pande.netlify.com"
+
+# servers:
+#   - url: "https://localhost:8000/api/v1"
+#     description: for local host -secure
+#   - url: "http://localhost:8000/api/v1"
+#     description: for local host -regular
+
+servers:
+  - url: "{protocol}://localhost:8000/api/{version}"
+    description: for local host -secure
+    variables:
+      version:
+        enum:
+          - v1
+          - v2
+        default: v1
+      protocol:
+        enum:
+          - http
+          - https
+        default: http
+components:
+  securitySchemes:
+    cookieAuth:
+      type: apiKey
+      in: cookie
+      name: token
+    BearerAuth:
+      type: http
+      scheme: bearer
+paths:
+  /d:
+    get:
+      tags:
+        - HOME
+      summary: return a greet message from LCO
+      responses:
+        200:
+          description: All good success
+          content:
+            application/json:
+              schema:
+                type: string
+                example: "mystring"
+        400:
+          description: Bad request
+        500:
+          description: internal server error