workspace-v1/shared/knowledge-base/templates/module-template/API.md

API Reference: {Nombre del Modulo}

Modulo: {module-id} Version: X.Y.Z

---

Tabla de Contenidos

• Service: {Module}Service
• DTOs
• Interfaces
• Guards
• Decorators

---

Service: {Module}Service

Constructor

constructor(
  private readonly configService: ConfigService,
  private readonly repository: Repository<{Entity}>,
)

Metodos

method1(param: Type): Promise<ReturnType>

Descripcion del metodo.

Parametros:

Parametro	Tipo	Requerido	Descripcion
param	Type	Si	Descripcion del parametro

Retorna: Promise<ReturnType>

Ejemplo:

const result = await service.method1({ param: 'value' });

Excepciones:

• NotFoundException: Cuando no se encuentra el recurso
• BadRequestException: Cuando los parametros son invalidos

---

method2(id: string, data: UpdateDto): Promise<Entity>

Descripcion del metodo.

Parametros:

Parametro	Tipo	Requerido	Descripcion
id	string	Si	ID del recurso
data	UpdateDto	Si	Datos a actualizar

Retorna: Promise<Entity>

---

DTOs

CreateDto

export class Create{Entity}Dto {
  @IsString()
  @IsNotEmpty()
  name: string;

  @IsEmail()
  email: string;

  @IsOptional()
  @IsString()
  description?: string;
}

UpdateDto

export class Update{Entity}Dto extends PartialType(Create{Entity}Dto) {}

ResponseDto

export class {Entity}ResponseDto {
  id: string;
  name: string;
  email: string;
  createdAt: Date;
  updatedAt: Date;
}

---

Interfaces

{Module}Options

export interface {Module}Options {
  apiKey: string;
  secret?: string;
  timeout?: number;
  retries?: number;
}

{Module}Config

export interface {Module}Config {
  enabled: boolean;
  options: {Module}Options;
}

---

Guards

{Module}Guard

Guard para proteger endpoints que requieren {modulo}.

@UseGuards({Module}Guard)
@Get('protected')
async protectedEndpoint() {
  // ...
}

---

Decorators

@{Module}()

Decorator para inyectar configuracion del modulo.

@{Module}()
async methodWithModule(@{Module}Config() config: {Module}Config) {
  // ...
}

---

Eventos

{Module}Event

Eventos emitidos por el modulo.

Evento	Payload	Descripcion
{module}.created	{ id, data }	Cuando se crea un recurso
{module}.updated	{ id, changes }	Cuando se actualiza
{module}.deleted	{ id }	Cuando se elimina

---

Errores

{Module}Exception

export class {Module}Exception extends HttpException {
  constructor(message: string, code: string) {
    super({ message, code }, HttpStatus.BAD_REQUEST);
  }
}

Codigos de Error

Codigo	Descripcion
{MODULE}_001	Error de configuracion
{MODULE}_002	Error de conexion
{MODULE}_003	Error de validacion

---

Generado: {fecha} Mantenedor: @Architecture-Analyst