zyket 1.0.25 → 1.0.27

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zyket",
-  "version": "1.0.25",
+  "version": "1.0.27",
   "main": "index.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
@@ -26,6 +26,8 @@
     "prompts": "^2.4.2",
     "redis": "^5.9.0",
     "sequelize": "^6.37.7",
-    "socket.io": "^4.8.1"
+    "socket.io": "^4.8.1",
+    "swagger-jsdoc": "^6.2.8",
+    "swagger-ui-express": "^5.0.1"
   }
 }

package/src/services/express/Express.js

@@ -6,12 +6,24 @@ const fs = require("fs");
 const path = require("path");
 const fg = require('fast-glob');
 const Middleware = require("./Middleware");
+const swaggerJsDoc = require("swagger-jsdoc");
+const swaggerUi = require("swagger-ui-express");
 
 
 module.exports = class Express extends Service {
   #container;
   #app;
   #httpServer;
+  static swaggerConfig = {
+    info: {
+      title: process.env.API_DOCS_TITLE  || "API Documentation",
+      version: version,
+      description: process.env.API_DOCS_DESCRIPTION || "API Documentation generated by Swagger",
+    },
+    servers: [
+      { url: `http://localhost:3000` }
+    ],
+  }
 
   constructor(container) {
     super("express");
@@ -30,6 +42,17 @@ module.exports = class Express extends Service {
     this.#app.use(cors({
       origin: '*'
     }))
+    
+    // get version from package json
+    const version = require(path.join(process.cwd(), "package.json")).version;
+
+    // Swagger setup
+    const swaggerOptions = {
+      ...Express.swaggerConfig,
+      apis: [path.join(process.cwd(), "src", "routes", "**", "*.js")],
+    };
+    const swaggerDocs = swaggerJsDoc(swaggerOptions);
+    this.#app.use("/docs", swaggerUi.serve, swaggerUi.setup(swaggerDocs));
 
     const routes = await this.#loadRoutesFromFolder(path.join(process.cwd(), "src", "routes"));