快速上手

从注册、创建工作区到产出第一个应用的最小路径指南。

步骤 1

注册并登录

在 Sys-Designer 官网注册账号,获取独立的 PRIVATE-TOKEN 凭证。

步骤 2

创建工作区

新建工作区,进入模型设计器开始定义业务模型。

步骤 3

产出第一个应用

通过模型设计与应用包导出,得到前后端一体的可部署应用。

核心概念

搞懂这些术语让你少走弯路。

模型驱动

事实定源

以模型为单一事实来源,改一处模型,UI、接口、引用资源自动级联同步。

设计即应用

标准化产出

设计态标准资产经校验与测试通过后,直接经应用包导出部署。

资产沉淀

三边网络

每次生产都沉淀为可复用模型 / 组件 / 规则资产。

MCP 接入

通过标准 MCP 协议把平台能力接入你的工作流与智能体。

平台以 MCP(Model Context Protocol)标准协议对外开放能力,包括数据模型、规则体系、UI 设计、资源校验、测试等能力域。

能力域一览

数据模型、规则体系、UI 设计、资源校验、测试——点击首页 MCP 查看各能力域文档。

接入方式

在 CodeBuddy / Cursor / VSCode 中按各能力域文档的「链接配置」接入,填入你的 PRIVATE-TOKEN 即可调用。

常见问题

校验失败、模型标识、组件绑定等高频疑问的解答集合。

校验

校验失败怎么办

平台提供「校验 → 修复 → 再校验」自愈闭环,AI 会自动诊断并修复,无需人工兜底。

模型标识

标识命名规范

模型标识须为英文且首字母大写(如 User、OrderInfo),否则会校验报错。

组件绑定

UI 绑定模型

组件的数据绑定需指向模型本身,否则会提示「模型标识不能为空」。

标签

节点显示 trial / latest

文件节点名旁的标签表示「试用 / 最新」状态,详见「试用 / 最新标签」章节。

工作台与界面

登录后进入工作台首页,点击顶部「开始设计」即可进入设计器工作区。

布局

三区工作台

  • 资源区(左侧):分组管理模型 / 函数 / 测试 / 数据源 / 账号 / 配置 / 应用。
  • 设计区:流程编排画布,提供 7 类只读节点库(通用 / 变量 / 数据 / 应用 / 函数 / 逻辑 / 加解密)。
  • 文件区:文件树,支持展开记忆与拖拽关联。
交互

常用操作

  • 双击节点:打开对应编辑器(模型 / 函数 / 测试)。
  • 拖拽:从资源树把模型 / 属性 / 枚举拖到目标节点完成关联或字段映射。
  • 展开记忆:文件树展开状态本地记忆,刷新后保持。
资源树的菜单分组由平台按设计规范自动生成,与模型、函数、测试、应用等模块一一对应。

模型设计操作

模型是平台的「事实定源」,所有界面、接口、引用资源均从模型推导,改一处模型即可联动同步。

模型分组与层级

结构

资源区模型节点

  • 模型分组:业务模块的一级归类,便于按域管理模型。
  • 模型:每个分组下可创建多个模型,平台按模型类型自动分桶展示。

模型类型

分类

六类模型

  • 输入模型:接口入参结构,描述前端或调用方提交的数据。
  • 输出模型:接口返回结构,描述响应给前端的数据。
  • 枚举模型:可复用的取值集合,供其他模型的字段引用。
  • 实体模型:业务实体,承载核心领域对象。
  • 源模型:公共基础属性来源(如带主键的领域公共字段)。
  • 表模型:领域模型,对应一张业务数据表。

创建模型分组

步骤

新建分组

  • 在资源区「模型」下点击「新建分组」,填写分组名与标识。
  • 标识须为英文且首字母大写,如 User、OrderInfo,建议全局保持唯一。

创建模型与定义属性

步骤

新建模型

  • 在分组下「新建模型」,选择一种模型类型。
  • 进入模型编辑器,在「属性」节点下逐字段定义名称、类型、是否必填、默认值、长度等。
  • 表模型会在「方法」节点下提供数据访问能力(如新增、按主键查询等),可直接选用。
组织

属性与字段

  • 属性以列表形式管理,公共基础字段可放到源模型中统一复用。
  • 引用类型字段可指向枚举模型或实体模型,建立模型间关联。
关联

拖拽关联枚举

  • 将枚举从资源树拖到模型属性上,完成字段与枚举的绑定。
  • 将属性拖到目标模型的属性上,完成字段映射与关联。

校验与建模指引

校验

即时校验

  • 创建 / 修改后执行资源校验,校验通过会给出明确提示。
  • 出错时平台提供「校验 → 修复 → 再校验」自愈闭环。
建模型前可先查看平台内置的建模约束说明,了解命名、类型与关联方面的通用要求,减少返工。

操作演示

演示:新建模型分组与模型、定义字段并关联枚举

函数设计操作

函数承载业务逻辑,由「函数分组 → 函数包 → 方法」三级结构组织。

资源区函数节点

结构

层级关系

  • 函数分组:可多级嵌套,用于按业务域归类函数。
  • 函数包:一组相关方法的集合,对应一个业务服务单元。
  • 方法:具体业务方法,按类型(如接口方法、查询方法等)自动分桶,并按所属路径归类展示。

创建函数包与方法

步骤

新建函数

  • 资源区「函数」下「新建函数分组」(可继续建子分组),再在分组下「新建函数包」。
  • 在函数包下「新建方法」,选择方法类型,填写名称与路径。
  • 双击方法节点打开函数编辑器,编写实现逻辑。

查看实现指引

指引

设计参考

  • 查看该方法的实现指引,了解标准写法与约束。
  • 查看函数流程编排指引,了解如何用流程方式组织方法逻辑。

关联模型与校验

关联

绑定模型

  • 把模型从资源树拖到函数方法上,建立数据引用。
  • 执行资源校验,检查函数与所依赖模型的一致性。
提示:围绕目标函数调整时,仅依据其自身流程、配置与所引用模型的真实数据,不要参考其他函数作为模板。

操作演示

演示:新建函数分组、函数包与方法,编写登录逻辑

测试操作

自动化测试内建,支持接口 / 端到端用例与可回溯报告。

创建并执行用例

步骤

执行测试

  • 执行测试用例,需填写用例类型(如接口 / 端到端)、是否为正向用例、以及用例标题(标题将关联到生成的测试报告)。
  • 双击资源区「测试 / 报告」节点查看运行结果。

自动生成用例

自动

函数用例自动生成

  • 基于函数方法自动生成测试用例。
  • 查看测试编写规范。
报告

报告查看

  • 在历史报告列表中查看过往运行记录,支持回溯审计。

测试截图

冒烟测试
冒烟测试:核心链路走通的用例结果
边界测试
边界测试:对临界输入的覆盖验证
非法输入测试
非法输入测试:异常与错误参数的校验结果
分支测试
分支测试:多分支逻辑的命中情况
分支测试详情
分支测试详情:单条分支用例的执行明细
自定义数据用例测试
自定义数据用例测试:手工构造数据的用例执行结果

函数流程设计

设计区用于流程编排,提供 7 类节点库作为编排素材,把方法逻辑以可视化方式组织起来。

七类节点库

通用

通用能力

  • 返回、异常、用户标识、登录账号、会话令牌的生成与解析、退出会话、用户信息等。
变量

变量类型

  • 整型、长整型、字符串、布尔、映射、任意类型,用于声明流程中的临时变量。
数据

数据操作

  • 设置缓存、接口聚合等数据层面的能力。
应用

应用动作

  • 构建、源码推送、文件上传、编译、部署、打包等发布相关动作。
函数

工具方法

  • 生成唯一标识、赋值、循环、过滤、追加、移除、排序、连接桩、事务、密码校验、会话验证码、发送验证码等可复用方法。
逻辑

逻辑判断

  • 有值、没值、相等、为真、为假、包含、条件断言等分支与判定的基础单元。
加解密

安全能力

  • RSA 加密 / 解密、AES 加密 / 解密、AES 密钥、密码加密、MD5 等。

编排与查看

操作

在画布中组织逻辑

  • 从节点库拖拽节点到画布,按业务顺序连接,构成方法的执行流程。
  • 双击节点可查看其说明与用法参考。
查询

查看已有流程

  • 查看流程总览,快速了解整体结构。
  • 查看流程节点清单与完整流程定义,便于核对与评审。

流程图的构造要素

要素

三类基本节点 + 连线

  • 入口:流程的起点,接收调用方传入的参数。
  • 处理节点:从节点库拖入的具体能力(校验、数据访问、逻辑判断、加解密等)。
  • 出口:以「通用 - 返回」节点给出结果,出错时用「通用 - 异常」节点返回错误。
  • 连线:把节点按执行顺序首尾相连;从某节点的输出锚点拖到下一节点的输入锚点即可建立连接。
容器

分支与循环节点

  • 「逻辑」类的条件判断、「函数」类的循环 / 过滤等节点本身是容器:把属于该分支或循环的节点拖入其范围内,连线也包在内部,形成嵌套结构。
  • 例如在「循环」节点内放置「追加」节点,即对集合逐项执行追加。

CRUD 流程图示例

以「用户」表模型为例,其方法节点自带新增、按主键查询、更新、删除等数据访问能力,下面给出每个动作的流程图构造。

C 创建

新增一条用户

  • 入口:接收用户入参(名称、状态等)。
  • 校验:用「逻辑 - 有值 / 相等」判断必填项是否齐全,缺失则走「通用 - 异常」。
  • 数据访问:调用该表模型「新增一条记录」能力写入数据。
  • 出口:用「通用 - 返回」回写新建记录(含主键)。
  • 连线顺序:入口 → 校验 →(通过)数据访问 → 返回;(不通过)异常。
R 查询

按主键查询用户

  • 入口:接收主键参数。
  • 校验:用「逻辑 - 有值」判断主键是否存在,缺失走「异常」。
  • 数据访问:调用「按主键查询」能力读取记录。
  • 判断:用「逻辑 - 有值」判断结果是否为空,为空走「异常 / 返回空」,非空走「返回」。
  • 连线顺序:入口 → 校验 → 数据访问 → 结果判断 →(有值)返回 /(无值)异常。
U 更新

更新用户信息

  • 入口:接收主键与待更新字段。
  • 校验:判断主键与必填字段。
  • 数据访问:先「按主键查询」确认记录存在,再调用「更新记录」能力。
  • 出口:「返回」更新后的记录;若查询为空走「异常」。
  • 连线顺序:入口 → 校验 → 查询 →(存在)更新 → 返回;(不存在)异常。
D 删除

删除用户

  • 入口:接收主键参数。
  • 校验:「逻辑 - 有值」判断主键。
  • 数据访问:调用「删除记录」能力。
  • 出口:「返回」删除成功;可先用「查询」确认存在再删除。
  • 连线顺序:入口 → 校验 → 删除 → 返回。
以上四个动作共用同一套构造模板:入口 → 校验 → 数据访问 → 结果判断 → 返回 / 异常。把校验与判断节点(逻辑类)作为容器,可把不同分支包成清晰的嵌套流程图。

流程图示样例(按主键查询用户)

下图基于设计器的真实节点类型绘制,可直接对照「资源区 → 设计节点库」中的节点名称进行搭建。

函数节点(开始,关联函数 ID)
↓
模型节点:入参 userId
↓
有值(判断 userId 是否有值)
否 ↓
异常处理(参数缺失)
是 ↓
数据表方法 repository:findById(关联用户表模型)
↓(是 分支继续)
有值(判断查询结果是否有值)
否 ↓
异常处理(用户不存在)
是 ↓
结束(返回用户)
图中节点类型(函数节点、模型节点、有值、数据表方法、异常处理、结束)均来自设计器的流程节点库;「数据表方法」的 method 填写 findById、addOne、updateById、deleteById 即可分别对应查询 / 新增 / 更新 / 删除。

文件管理

文件区是项目级文件树,支持展开记忆与拖拽关联。

操作

文件节点

  • 展开记忆:文件树展开 / 收起状态本地记忆,刷新后保持。
  • 拖拽关联:将文件或目录拖到目标资源节点完成引用。
  • 标签展示:文件节点名称旁若带 trial / latest 小标签,表示处于「试用」或「最新」状态(见下节)。

应用管理

应用 = 设计态资产 + 应用包,导出后即为可直接部署运行的完整应用。

步骤

组织应用

  • 资源区「应用」下按模板分组管理。
  • 将设计好的模型 / 函数 / 页面拖入应用,建立依赖关系。
  • 应用包支持导出为可运行的后端服务与前端页面。
设计即应用:设计态标准资产经校验与测试通过后,直接经应用包导出部署,无需人工编写与联调。

操作截图

新增应用
新增应用:创建应用并组织设计态资产
查询应用
查询应用:查看已发布应用的运行信息
删除应用
删除应用:移除不再需要的应用

试用 / 最新标签

文件节点名称旁的小标签用于标识节点状态,由节点的状态标签数据驱动。

机制

TagOption 结构

  • 每个标签包含两个信息:一个是显示的文字(如「试用」「最新」),一个是用于区分样式的标识。
  • 标识为 trial 时,对应「试用」文字显示橙红色;标识为 latest 时,对应「最新」文字显示蓝色。
展示

前端渲染

  • 在文件节点名称旁直接展示对应的小标签。
  • 标签以文字小标签形式展示,不阻塞节点交互。

MCP 工具串联

通过 MCP 标准协议批量操作平台资源,能力域与工具清单如下。

能力域

模型

数据模型

  • 查询与维护模型分组、模型详情、字段信息,以及分组与字段的增删改。
函数

函数

  • 查询函数包与方法列表,查看函数实现指引与流程编排指引。
界面

UI 设计

  • 管理 UI 分组与页面,查看界面设计指引。
流程

流程

  • 查看流程总览、节点清单与完整流程定义。
测试

测试

  • 执行测试用例、自动生成函数用例、查看历史报告与测试编写规范。
规则

规则

  • 查询建模、界面、函数实现、函数流程等内置约束规则(多为只读)。
校验

资源校验

  • 对各类资源执行校验,覆盖全部资源类型,校验通过会给出明确提示。
规则体系为只读能力域,沉淀自真实项目约束,在 AI 生成环节框定边界、保障产出质量。

端到端案例

以「搭建用户查询接口」为例,跑通最小闭环(建模型 → 编码 → 测试 → 关联应用)。

1

创建模型分组与表

资源区「模型」下新建分组 User,再建普通表模型 User。

2

定义字段并关联枚举

在「属性」节点加 id / name / status,将枚举拖到 status 完成绑定;在「方法」勾选 CRUD。

3

编写函数并关联模型

新建函数包与方法,查看实现指引,将模型拖入方法建立引用。

4

校验

执行资源校验检查模型,校验通过会有提示;出错走自愈闭环。

5

测试

自动生成函数用例并执行测试,双击「报告」节点查看结果。

6

建立应用依赖

「应用」下将模型与函数拖入应用,经应用包导出为可直接部署运行的完整应用。

端到端 MCP 调用顺序可概括为:建模 → 取 Skill → 写函数 → 校验 → 自动建用例 → 执行测试 → 看报告 → 应用组装 → 再校验。