Módulos YAML

Los módulos YAML definen la estructura y comportamiento de tu aplicación.

Sintaxis Básica

module: users
version: 1.0.0
description: Gestión de usuarios

entities:
  user:
    fields:
      id:
        type: uuid
        primary: true
      email:
        type: email
        unique: true
        required: true
      name:
        type: string
        max: 120
      created_at:
        type: timestamp
        default: now

endpoints:
  - method: GET
    path: /users
    auth: required

  - method: POST
    path: /users
    auth: optional

  - method: GET
    path: /users/{id}
    auth: required

  - method: PUT
    path: /users/{id}
    auth: required

Estructura de un Módulo

metadata

module: nombre_modulo
version: 1.0.0
description: Descripción breve
domain: backend|frontend|mobile|shared

entities

Define las entidades de datos del módulo.

endpoints

Define los endpoints API del módulo.

events

Define eventos que el módulo puede emitir.

handlers

Define handlers para eventos de otros módulos.

Autocompletado

El editor ofrece autocompletado inteligente:

• Presiona Ctrl+Space para ver suggestions
• Autocompleta nombres de módulos
• Valida tipos de campos
• Detecta errores de sintaxis

Validación

El módulo valida:

• YAML sintaxis (indentación, keys)
• Estructura de entities
• Tipos de datos válidos
• Referencias a otros módulos

CodeGen

Los módulos YAML son la base para:

• Backend: FastAPI/tRPC endpoints
• Frontend: Rutas y componentes
• Types: Interfaces TypeScript
• DB: Migraciones de base de datos

Imports

Un módulo puede importar de otros:

imports:
  - modules/[email protected]
  - modules/[email protected]