feat: minimal swagger ui integration

README.md

@@ -112,12 +112,12 @@ pnpm --filter web test
 - [x] tanstack react-query integration 
 - [x] add members
 - [x] realtime unread count 
-- [ ] leave group, transfer ownership, delete group
+- [x] leave group, transfer ownership, delete group
+- [x] delete group
 - [ ] alert component
 - [ ] confirm dialog
-- [ ] delete group
-- [ ] e2e encryption
 - [ ] read receipts
+- [ ] e2e encryption
 
 ### extras
 

server/package.json

@@ -10,7 +10,8 @@
     "lint": "tsc && eslint src/**/*.ts",
     "migrate:gen": "drizzle-kit generate",
     "migrate:run": "tsx src/scripts/migrate.ts",
-    "seed": "tsx src/scripts/seed.ts"
+    "seed": "tsx src/scripts/seed.ts",
+    "swag:gen": "tsx src/scripts/swagger.ts"
   },
   "keywords": [
     "socket.io",
@@ -34,7 +35,9 @@
     "lodash": "^4.17.21",
     "morgan": "^1.10.0",
     "pg": "^8.12.0",
-    "socket.io": "^4.7.5"
+    "socket.io": "^4.7.5",
+    "swagger-autogen": "^2.23.7",
+    "swagger-ui-express": "^5.0.1"
   },
   "devDependencies": {
     "@eslint/js": "^9.6.0",
@@ -46,6 +49,7 @@
     "@types/morgan": "^1.9.9",
     "@types/node": "^20.14.5",
     "@types/pg": "^8.11.6",
+    "@types/swagger-ui-express": "^4.1.6",
     "drizzle-kit": "^0.22.8",
     "eslint": "9.x",
     "globals": "^15.7.0",

server/src/index.ts

@@ -12,10 +12,11 @@ import cluster from 'node:cluster'
 import { createServer } from 'node:http'
 import { availableParallelism } from 'node:os'
 import { Server } from 'socket.io'
+import swaggerUi from 'swagger-ui-express'
 import { config } from './config'
 import { connectDB } from './database'
-import { auth, errorHandler } from './middlewares'
-import * as routes from './routes'
+import { errorHandler } from './middlewares'
+import rootRouter from './routes'
 import { registerSocketEvents } from './socket/events'
 import { socketAuthMiddleware } from './socket/middlewares'
 import {
@@ -24,6 +25,7 @@ import {
   ServerToClientEvents,
   SocketData,
 } from './socket/socket.interface'
+import swaggerDocument from './swagger-output.json'
 
 const createApp = async () => {
   if (cluster.isPrimary && config.isProd) {
@@ -99,9 +101,10 @@ const createApp = async () => {
     res.send('<h1>Welcome to mChat API</h1>')
   })
 
-  app.use('/api/users', routes.userRoutes)
-  app.use('/api/groups', auth, routes.groupRoutes)
-  app.use('/api/members', auth, routes.memberRoutes)
+  app.use(rootRouter)
+
+  app.use('/api-docs', swaggerUi.serve)
+  app.get('/api-docs', swaggerUi.setup(swaggerDocument))
 
   app.use(errorHandler)
 

server/src/routes.ts

@@ -1,3 +1,14 @@
-export { router as groupRoutes } from '@/modules/groups/groups.routes'
-export { router as memberRoutes } from '@/modules/members/members.routes'
-export { router as userRoutes } from '@/modules/users/users.routes'
+import { Router } from 'express'
+import { auth } from './middlewares'
+
+import { router as groupRoutes } from '@/modules/groups/groups.routes'
+import { router as memberRoutes } from '@/modules/members/members.routes'
+import { router as userRoutes } from '@/modules/users/users.routes'
+
+const rootRouter = Router()
+
+rootRouter.use('/api/users', userRoutes)
+rootRouter.use('/api/groups', auth, groupRoutes)
+rootRouter.use('/api/members', auth, memberRoutes)
+
+export default rootRouter

server/src/scripts/swagger.ts

@@ -0,0 +1,27 @@
+import swaggerAutogen from 'swagger-autogen'
+
+const doc = {
+  info: {
+    version: '1.0.0',
+    title: 'mChat',
+    description: 'Realtime messenger powered by socket.io',
+  },
+  host: 'localhost:3000',
+  components: {
+    securitySchemes: {
+      bearerAuth: {
+        type: 'http',
+        scheme: 'bearer',
+      },
+    },
+  },
+  schemes: ['http', 'https'],
+}
+
+const outputFile = '../swagger-output.json'
+const routes = ['./../routes.ts']
+
+/* NOTE: If you are using the express Router, you must pass in the 'routes' only the 
+root file where the route starts, such as index.js, app.js, routes.js, etc ... */
+
+swaggerAutogen()(outputFile, routes, doc)