Skip to content

顶层结构

每份 Schema 描述一个组件实例的完整展示行为,顶层结构如下:

json
{
  "version": "1.0",
  "id": "order-table",
  "name": "订单列表",
  "type": "DataTable",
  "permission": "order:list:view",
  "dicts": { ... },
  "externalDeps": { ... },
  "props": { ... }
}

字段说明

字段类型必填说明
versionstring协议版本号,格式 major.minor,用于迁移(详见 版本迁移
idstringSchema 唯一标识
namestring可读名称,Designer 中展示用
typestring渲染类型:DataTable / Form / Descriptions
permissionstringType 级权限标识,无权限时整个组件不渲染
dictsobjectDesigner 预配置的静态字典
externalDepsobject外部依赖声明(Designer 自动生成)
propsobject组件配置,结构由 type 决定

Type 类型

Schemly 支持三种布局容器类型:

Type用途数据类型详细文档
DataTable数据表格,支持增删改查arrayDataTable 协议
Form通用表单(搜索、筛选、编辑)objectForm 协议
Descriptions描述列表(详情展示)objectDescriptions 协议

关键设计

  • Schema 纯展示描述:不包含请求逻辑、路由逻辑,数据由 Runtime props 传入
  • props 结构由 type 决定:不同 Type 有不同的 props 字段集
  • externalDeps 自动生成:Designer 保存时自动扫描依赖,业务方无需手写

Released under the MIT License.