AgentSkillsCN

xeku-yaml-guide

XekuII 實體定義 YAML 撰寫指南。當需要新增或修改 `entities/**/*.xeku.yaml` 時使用。

中文原作
SKILL.md
--- frontmatter
name: xeku-yaml-guide
description: XekuII 實體定義 YAML 撰寫指南。當需要新增或修改 `entities/**/*.xeku.yaml` 時使用。

XekuII YAML 實體定義指南

Overview

在 entities/ 內建立 .xeku.yaml 定義，Generator 會生成後端與前端產物。

Core Structure

yaml
entity: Product
caption: 產品
icon: BO_Product
dbTable: Products
description: Product inventory management

Fields

yaml
fields:
  - name: Code
    type: string
    required: true
    length: 20
    label: 產品代碼
    validations:
      - regex: "^[A-Z]{2}-\\d{4}$"
        message: "Code format must be like AB-1234"

Relations

yaml
relations:
  - name: Category
    type: reference
    target: ProductCategory
    required: true
    label: 產品分類
    lookupField: Name

Enums

yaml
enums:
  - name: ProductStatus
    members:
      - name: Draft
        value: 0
        label: 草稿
      - name: Active
        value: 1
        label: 上架中

UI Config

yaml
ui:
  list:
    columns: [Code, Name, Category, Price]
    defaultSort: Name
    defaultSortDir: asc
    searchable: [Code, Name]
    filterable: [Status, Category]
    pageSize: 25
  form:
    layout:
      - row: [Code, Name]
      - row: [Category, Status]
  detail:
    sections:
      - title: 基本資訊
        fields: [Code, Name, Category]

Permissions

yaml
permissions:
  read: Default
  create: Default
  update: Default
  delete: Administrators

Defaults

yaml
# examples
default: "0"
default: "true"
default: "now"
default: "today"
default: "utcnow"
default: "new"
default: "Draft"

Common Errors

  • •Enum 型別名稱大小寫不一致
  • •反向關聯目標實體未定義
  • •validations 非 list 格式
  • •default 未用引號