added Swagger-Openapispec todo:bringbackEC2

Author: Thisshonrobert

apps/bank-webhook/package.json

@@ -3,19 +3,27 @@
   "version": "1.0.0",
   "description": "",
   "main": "index.js",
+
   "scripts": {
-    "build": "npx esbuild ./src/index.ts --bundle --platform=node --outfile=dist/index.js",
-    "start": "node dist/index.js",
-    "dev": "npm run build && npm run start"
-  },
+  "build": "tsc && npm run swagger:build",
+  "start": "node dist/index.js",
+  "dev": "npx ts-node ./src/index.ts",
+  "swagger:build": "node scripts/generate-swagger.js"
+},
   "keywords": [],
   "author": "",
   "license": "ISC",
   "dependencies": {
     "@repo/db": "*",
     "@types/express": "^4.17.21",
-    "esbuild": "^0.20.2",
+    "esbuild": "^0.25.8",
     "express": "^4.19.1",
-    "zod": "^3.23.8"
+    "swagger-jsdoc": "^6.2.8",
+    "swagger-ui-express": "^5.0.1",
+    "zod": "^3.25.76"
+  },
+  "devDependencies": {
+    "@types/swagger-jsdoc": "^6.0.4",
+    "@types/swagger-ui-express": "^4.1.8"
   }
 }

apps/bank-webhook/scripts/generate-swagger.js

@@ -0,0 +1,19 @@
+const swaggerJSDoc = require('swagger-jsdoc');
+const fs = require('fs');
+const path = require('path');
+
+const swaggerOptions = {
+  definition: {
+    openapi: "3.0.0",
+    info: {
+      title: "VPay Bank Webhook API",
+      version: "1.0.0",
+      description: "API documentation for the bank webhook endpoint"
+    }
+  },
+  apis: [path.join(__dirname, "../src/index.ts")], // Adjust if your file is elsewhere
+};
+
+const swaggerSpec = swaggerJSDoc(swaggerOptions);
+fs.writeFileSync(path.join(__dirname, "../dist/swagger.json"), JSON.stringify(swaggerSpec, null, 2));
+console.log("Swagger JSON generated at dist/swagger.json");

apps/bank-webhook/src/index.ts

@@ -2,18 +2,49 @@ import express from "express";
 import db from "@repo/db/client";
 import { z } from "zod";
 
-
+import swaggerUi from 'swagger-ui-express';
+import swaggerDocument from '../dist/swagger.json';
 const app = express();
 
 app.use(express.json())
 
+app.use("/api-docs", swaggerUi.serve, swaggerUi.setup(swaggerDocument));
 
 const paymentSchema = z.object({
     token: z.string(),
     user_identifier: z.string(),
     amount: z.string(),
     PaymentResponse:z.enum(["Success", "Failure"])
 });
+/**
+ * @swagger
+ * /hdfcWebhook:
+ *   post:
+ *     summary: HDFC webhook for payment response
+ *     requestBody:
+ *       required: true
+ *       content:
+ *         application/json:
+ *           schema:
+ *             type: object
+ *             properties:
+ *               token:
+ *                 type: string
+ *               user_identifier:
+ *                 type: string
+ *               amount:
+ *                 type: string
+ *               PaymentResponse:
+ *                 type: string
+ *                 enum: [Success, Failure]
+ *     responses:
+ *       200:
+ *         description: Payment recorded
+ *       400:
+ *         description: Bad Request
+ *       411:
+ *         description: Length Required
+ */
 
 app.post("/hdfcWebhook", async (req, res) => {
 
@@ -136,5 +167,7 @@ enum PaymentResponse {
     }
 
 })
-console.log("server is running")
-app.listen(3003);
+app.listen(3003, () => {
+  console.log("Server running at http://localhost:3003");
+  console.log("Docs available at http://localhost:3003/api-docs");
+});

apps/bank-webhook/tsconfig.json

@@ -1,8 +1,16 @@
 {
-  "extends": "@repo/typescript-config/base.json",
+  // "extends": "@repo/typescript-config/base.json",
   "compilerOptions": {
-    "outDir": "dist"
+    "outDir": "dist",
+    "module": "node16",
+    "target": "es2019",
+    "moduleResolution": "node16",
+    "esModuleInterop": true,
+    "strict": true,
+    "skipLibCheck": true,
+    "rootDir": "src",
+    "resolveJsonModule": true,
   },
   "include": ["src"],
-  "exclude": ["node_modules", "dist"]
+  "exclude": ["node_modules"]
 }