done swagger api doc config

Author: secretariatv

.prettierrc

@@ -2,5 +2,7 @@
     "printWidth": 120,
     "semi": true,
     "singleQuote": true,
-    "bracketSpacing": false
+    "bracketSpacing": false,
+    "tabWidth": 2,
+    "useTabs": false
 }

README.md

@@ -68,6 +68,7 @@ A comprehensive and professional Node.js backend boilerplate designed for buildi
 - [x] **Error Handling**: Centralized error handling mechanism
 - [ ] **Testing Framework**: Vitest for reliable unit and integration testing
 - [ ] **Communicate with fe using session**: Implement session-based communication with `express-session`
+- [ ] **API Documentation**: Add Swagger UI
 
 ### **Enhancements**
 

package.json

@@ -28,6 +28,8 @@
     "@eslint/js": "^9.15.0",
     "@types/express": "^5.0.0",
     "@types/supertest": "^6.0.2",
+    "@types/swagger-jsdoc": "^6.0.4",
+    "@types/swagger-ui-express": "^4.1.7",
     "eslint": "^9.15.0",
     "globals": "^15.12.0",
     "husky": "^9.1.7",
@@ -43,6 +45,8 @@
     "dotenv": "^16.4.5",
     "express": "^4.21.1",
     "mongoose": "^8.8.2",
+    "swagger-jsdoc": "^6.2.8",
+    "swagger-ui-express": "^5.0.1",
     "ts-node": "^10.9.2"
   }
 }