swagger

src/seccion/dto/create-seccion.dto.ts

@@ -1 +1,23 @@
-export class CreateSeccionDto {}
+import { CreatePreguntaDto } from '../../pregunta/dto/create-pregunta.dto';
+import { IsArray, IsNotEmpty, IsNumber, IsOptional, IsString, ValidateNested } from 'class-validator';
+import { Type } from 'class-transformer';
+
+export class CreateSeccionDto {
+  @IsNotEmpty()
+  @IsString()
+  titulo: string;
+
+  @IsOptional()
+  @IsString()
+  descripcion?: string;
+
+  @IsOptional()
+  @IsNumber()
+  contador_pregunta?: number;
+
+  @IsOptional()
+  @IsArray()
+  @ValidateNested({ each: true })
+  @Type(() => CreatePreguntaDto)
+  preguntas?: CreatePreguntaDto[];
+}

src/seccion/entities/seccion.entity.ts

@@ -11,7 +11,7 @@ export class Seccion {
   contador_pregunta: number;
 
   @Column({ type: 'text', nullable: true })
-  descripcion: string;
+  descripcion?: string;
 
   @Column({ type: 'text', nullable: true })
   titulo: string;

src/seccion/seccion.controller.ts

@@ -2,32 +2,39 @@ import { Controller, Get, Post, Body, Patch, Param, Delete } from '@nestjs/commo
 import { SeccionService } from './seccion.service';
 import { CreateSeccionDto } from './dto/create-seccion.dto';
 import { UpdateSeccionDto } from './dto/update-seccion.dto';
+import { SeccionApiDocumentation } from './seccion.documentation';
 
 @Controller('seccion')
+@SeccionApiDocumentation.ApiController
 export class SeccionController {
   constructor(private readonly seccionService: SeccionService) {}
 
   @Post()
+  @SeccionApiDocumentation.ApiCreate
   create(@Body() createSeccionDto: CreateSeccionDto) {
     return this.seccionService.create(createSeccionDto);
   }
 
   @Get()
+  @SeccionApiDocumentation.ApiGetAll
   findAll() {
     return this.seccionService.findAll();
   }
 
   @Get(':id')
+  @SeccionApiDocumentation.ApiGetOne
   findOne(@Param('id') id: string) {
     return this.seccionService.findOne(+id);
   }
 
   @Patch(':id')
+  @SeccionApiDocumentation.ApiUpdate
   update(@Param('id') id: string, @Body() updateSeccionDto: UpdateSeccionDto) {
     return this.seccionService.update(+id, updateSeccionDto);
   }
 
   @Delete(':id')
+  @SeccionApiDocumentation.ApiRemove
   remove(@Param('id') id: string) {
     return this.seccionService.remove(+id);
   }

src/seccion/seccion.documentation.ts

@@ -0,0 +1,185 @@
+import { ApiBody, ApiOperation, ApiParam, ApiResponse, ApiTags } from '@nestjs/swagger';
+import { applyDecorators } from '@nestjs/common';
+
+export class SeccionApiDocumentation {
+  // Decoradores para toda la clase del controlador
+  static ApiController = ApiTags('Secciones');
+
+  // Documentación para crear una sección
+  static ApiCreate = applyDecorators(
+    ApiOperation({
+      summary: 'Crear una nueva sección',
+      description: 'Crea una nueva sección para un cuestionario'
+    }),
+    ApiBody({
+      description: 'Datos de la sección a crear',
+      schema: {
+        type: 'object',
+        required: ['titulo'],
+        properties: {
+          titulo: { type: 'string', example: 'Información Personal' },
+          descripcion: { 
+            type: 'string', 
+            example: 'Proporciona tus datos personales para poder contactarte'
+          },
+          contador_pregunta: { type: 'number', example: 0 },
+          preguntas: {
+            type: 'array',
+            items: {
+              type: 'object',
+              properties: {
+                titulo: { type: 'string', example: '¿Eres parte de la comunidad?' },
+                obligatoria: { type: 'boolean', example: true },
+                tipo: { type: 'string', example: 'Multiple' },
+                opciones: {
+                  type: 'array',
+                  items: {
+                    type: 'object',
+                    properties: {
+                      valor: { type: 'string', example: 'Si' }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }),
+    ApiResponse({ 
+      status: 201, 
+      description: 'Sección creada correctamente',
+      schema: {
+        type: 'object',
+        properties: {
+          id_seccion: { type: 'number', example: 1 },
+          titulo: { type: 'string', example: 'Información Personal' },
+          descripcion: { type: 'string' },
+          contador_pregunta: { type: 'number', example: 0 }
+        }
+      }
+    }),
+    ApiResponse({ status: 400, description: 'Datos de la sección inválidos' }),
+    ApiResponse({ status: 500, description: 'Error interno del servidor' })
+  );
+
+  // Documentación para obtener todas las secciones
+  static ApiGetAll = applyDecorators(
+    ApiOperation({
+      summary: 'Obtener todas las secciones',
+      description: 'Retorna una lista de todas las secciones registradas'
+    }),
+    ApiResponse({
+      status: 200,
+      description: 'Lista de secciones obtenida correctamente',
+      schema: {
+        type: 'array',
+        items: {
+          type: 'object',
+          properties: {
+            id_seccion: { type: 'number', example: 1 },
+            titulo: { type: 'string', example: 'Información Personal' },
+            descripcion: { type: 'string' },
+            contador_pregunta: { type: 'number', example: 0 }
+          }
+        }
+      }
+    }),
+    ApiResponse({ status: 500, description: 'Error interno del servidor' })
+  );
+
+  // Documentación para obtener una sección por ID
+  static ApiGetOne = applyDecorators(
+    ApiOperation({
+      summary: 'Obtener una sección por ID',
+      description: 'Retorna una sección específica por su ID'
+    }),
+    ApiParam({
+      name: 'id',
+      description: 'ID de la sección',
+      required: true,
+      type: 'number',
+      example: 1
+    }),
+    ApiResponse({
+      status: 200,
+      description: 'Sección obtenida correctamente',
+      schema: {
+        type: 'object',
+        properties: {
+          id_seccion: { type: 'number', example: 1 },
+          titulo: { type: 'string', example: 'Información Personal' },
+          descripcion: { type: 'string' },
+          contador_pregunta: { type: 'number', example: 0 }
+        }
+      }
+    }),
+    ApiResponse({ status: 404, description: 'Sección no encontrada' }),
+    ApiResponse({ status: 500, description: 'Error interno del servidor' })
+  );
+
+  // Documentación para actualizar una sección
+  static ApiUpdate = applyDecorators(
+    ApiOperation({
+      summary: 'Actualizar una sección',
+      description: 'Actualiza los datos de una sección existente'
+    }),
+    ApiParam({
+      name: 'id',
+      description: 'ID de la sección a actualizar',
+      required: true,
+      type: 'number',
+      example: 1
+    }),
+    ApiBody({
+      description: 'Datos a actualizar de la sección',
+      schema: {
+        type: 'object',
+        properties: {
+          titulo: { type: 'string', example: 'Título actualizado' },
+          descripcion: { type: 'string', example: 'Descripción actualizada' }
+        }
+      }
+    }),
+    ApiResponse({
+      status: 200,
+      description: 'Sección actualizada correctamente',
+      schema: {
+        type: 'object',
+        properties: {
+          affected: { type: 'number', example: 1 }
+        }
+      }
+    }),
+    ApiResponse({ status: 400, description: 'Datos de actualización inválidos' }),
+    ApiResponse({ status: 404, description: 'Sección no encontrada' }),
+    ApiResponse({ status: 500, description: 'Error interno del servidor' })
+  );
+
+  // Documentación para eliminar una sección
+  static ApiRemove = applyDecorators(
+    ApiOperation({
+      summary: 'Eliminar una sección',
+      description: 'Elimina permanentemente una sección por su ID'
+    }),
+    ApiParam({
+      name: 'id',
+      description: 'ID de la sección a eliminar',
+      required: true,
+      type: 'number',
+      example: 1
+    }),
+    ApiResponse({
+      status: 200,
+      description: 'Sección eliminada correctamente',
+      schema: {
+        type: 'object',
+        properties: {
+          affected: { type: 'number', example: 1 }
+        }
+      }
+    }),
+    ApiResponse({ status: 404, description: 'Sección no encontrada' }),
+    ApiResponse({ status: 500, description: 'Error interno del servidor' })
+  );
+}