feat: implement Swagger/OpenAPI documentation (#52) (Apertre3.0)

backend/Swagger.js

@@ -140,7 +140,11 @@ const options = {
       },
     },
   },
+
+  apis: ['./routes/*.js'], // Auto-discover docs from route files, // Keep this empty now since we defined paths directly above!
+
   apis: [], // Keep this empty now since we defined paths directly above!
+
 };
 
 const swaggerSpec = swaggerJsdoc(options);

backend/index.js

@@ -1,4 +1,5 @@
 import dotenv from "dotenv";
+import cookieParser from 'cookie-parser';
 dotenv.config();
 import swaggerUi from 'swagger-ui-express';
 import swaggerSpec from './Swagger.js'; // Note: The .js extension is required for ES modules!

backend/routes/authRoutes.js

@@ -3,6 +3,29 @@ import { registration, login, logOut, googleLogin, adminLogin } from '../control
 
 const authRoutes = express.Router();
 
+/**
+ * @swagger
+ * /api/auth/registration:
+ * post:
+ * summary: Register a new user
+ * tags: [Auth]
+ * requestBody:
+ * required: true
+ * content:
+ * application/json:
+ * schema:
+ * type: object
+ * required: [name, email, password]
+ * properties:
+ * name: { type: string, example: "John Doe" }
+ * email: { type: string, example: "john@example.com" }
+ * password: { type: string, example: "StrongPass123!" }
+ * responses:
+ * 201:
+ * description: User registered successfully
+ */
+
+
 authRoutes.post("/registration", registration);
 authRoutes.post("/login", login);
 authRoutes.get("/logout", logOut);