update

config/swagger.js

@@ -0,0 +1,201 @@
+const swaggerJsdoc = require('swagger-jsdoc');
+const swaggerUi = require('swagger-ui-express');
+
+const options = {
+  definition: {
+    openapi: '3.0.0',
+    info: {
+      title: 'SENA School Management API',
+      version: '1.0.0',
+      description: 'API documentation for SENA School Management System with 200 schools',
+      contact: {
+        name: 'SENA Team',
+        email: 'support@sena.vn',
+      },
+      license: {
+        name: 'MIT',
+        url: 'https://opensource.org/licenses/MIT',
+      },
+    },
+    servers: [
+      {
+        url: 'http://localhost:3000',
+        description: 'Development server',
+      },
+      {
+        url: 'https://api.sena.vn',
+        description: 'Production server',
+      },
+    ],
+    components: {
+      securitySchemes: {
+        bearerAuth: {
+          type: 'http',
+          scheme: 'bearer',
+          bearerFormat: 'JWT',
+          description: 'Enter JWT token from /api/auth/login',
+        },
+      },
+      schemas: {
+        Error: {
+          type: 'object',
+          properties: {
+            success: {
+              type: 'boolean',
+              example: false,
+            },
+            message: {
+              type: 'string',
+              example: 'Error message',
+            },
+          },
+        },
+        UserProfile: {
+          type: 'object',
+          properties: {
+            id: {
+              type: 'string',
+              format: 'uuid',
+              example: '123e4567-e89b-12d3-a456-426614174000',
+            },
+            user_id: {
+              type: 'string',
+              format: 'uuid',
+            },
+            full_name: {
+              type: 'string',
+              example: 'Nguyễn Văn A',
+            },
+            date_of_birth: {
+              type: 'string',
+              format: 'date',
+              example: '2010-01-01',
+            },
+            gender: {
+              type: 'string',
+              enum: ['male', 'female', 'other'],
+              example: 'male',
+            },
+            phone: {
+              type: 'string',
+              example: '0901234567',
+            },
+            avatar_url: {
+              type: 'string',
+              example: 'https://example.com/avatar.jpg',
+            },
+            address: {
+              type: 'string',
+              example: '123 Đường ABC, Quận 1, TP.HCM',
+            },
+            primary_role_info: {
+              type: 'object',
+              properties: {
+                role_id: { type: 'string', format: 'uuid' },
+                role_code: { type: 'string', example: 'student' },
+                role_name: { type: 'string', example: 'Học sinh' },
+                school: {
+                  type: 'object',
+                  properties: {
+                    id: { type: 'string', format: 'uuid' },
+                    name: { type: 'string', example: 'SENA Hà Nội' },
+                  },
+                },
+                class: {
+                  type: 'object',
+                  properties: {
+                    id: { type: 'string', format: 'uuid' },
+                    name: { type: 'string', example: 'K1A' },
+                  },
+                },
+                grade: {
+                  type: 'object',
+                  properties: {
+                    id: { type: 'string', format: 'uuid' },
+                    name: { type: 'string', example: 'Khối 1' },
+                  },
+                },
+              },
+            },
+          },
+        },
+        RoleInfo: {
+          type: 'object',
+          properties: {
+            role_id: {
+              type: 'string',
+              format: 'uuid',
+            },
+            role_code: {
+              type: 'string',
+              example: 'student',
+            },
+            role_name: {
+              type: 'string',
+              example: 'Học sinh',
+            },
+            school: {
+              type: 'object',
+              nullable: true,
+            },
+            class: {
+              type: 'object',
+              nullable: true,
+            },
+            grade: {
+              type: 'object',
+              nullable: true,
+            },
+          },
+        },
+        Permission: {
+          type: 'object',
+          properties: {
+            code: {
+              type: 'string',
+              example: 'view_own_grades',
+            },
+            name: {
+              type: 'string',
+              example: 'Xem điểm của mình',
+            },
+            resource: {
+              type: 'string',
+              example: 'grades',
+            },
+            action: {
+              type: 'string',
+              example: 'view',
+            },
+          },
+        },
+      },
+    },
+    tags: [
+      {
+        name: 'Authentication',
+        description: 'User authentication and authorization endpoints',
+      },
+      {
+        name: 'Schools',
+        description: 'School management endpoints',
+      },
+      {
+        name: 'Students',
+        description: 'Student management endpoints',
+      },
+      {
+        name: 'Teachers',
+        description: 'Teacher management endpoints',
+      },
+    ],
+  },
+  apis: ['./controllers/*.js', './routes/*.js'], // Path to the API docs
+};
+
+const swaggerSpec = swaggerJsdoc(options);
+
+module.exports = {
+  swaggerUi,
+  swaggerSpec,
+};