Files
qhmes/.trae/skills/jeecg-desform/docs/skill-usage-guide.md

138 lines
3.3 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# jeecg-aiform 使用指南
## 快速开始
### 1. 自然语言描述表单
直接告诉 AI 你需要什么表单:
```
帮我创建一个请假申请表单,包含:
- 姓名(必填)
- 请假类型(事假/病假/年假,单选)
- 开始日期
- 结束日期
- 请假天数
- 请假原因
- 附件
```
### 2. 提供连接信息
AI 会要求你提供:
- **后端地址**:如 `https://boot3.jeecg.com/jeecgboot`
- **X-Access-Token**:从浏览器 F12 → Network → 任意请求的 Headers 中复制
### 3. 确认后自动创建
AI 会展示表单摘要(字段列表、控件类型),确认后自动调用 API 创建。
---
## 多种描述方式
以下描述方式都会触发 AI 表单生成:
| 描述方式 | 示例 |
|---------|------|
| 直接说创建表单 | "创建一个员工信息表单" |
| 描述字段需求 | "我需要一个表单,有姓名、手机号、地址" |
| 描述业务场景 | "做一个采购单,包含采购明细子表" |
| 简短指令 | "AI设计表单报销申请" |
| 英文指令 | "generate a leave application form" |
---
## 支持的控件类型
### 基础字段
- 单行文本、多行文本、数字、整数、金额
### 选择字段
- 单选框、多选框、下拉选择、下拉树
### 日期时间
- 日期选择器、时间选择器、日期范围
### 交互控件
- 开关、评分、滑块、颜色选择器
### 上传控件
- 图片上传、文件上传
### 联系方式
- 手机、邮箱
### 富文本
- 富文本编辑器、Markdown 编辑器
### 高级字段
- 省市级联动、地图、定位、条码、自动编号、文本组合
### 人员组织
- 用户选择、部门选择、岗位选择、组织角色
### 关联控件
- 关联记录、他表字段、汇总
### 布局控件
- 设计子表(明细表)
---
## 修改已有表单
如果要修改已创建的表单:
```
修改表单 xxx增加一个"审批意见"多行文本字段
```
需要提供表单 ID 或编码。
---
## 常见场景示例
### 员工信息登记
```
创建员工信息登记表单:姓名(必填)、工号(必填)、手机、邮箱、部门、入职日期、备注、头像照片
```
### 请假申请
```
做一个请假申请表单:
- 申请人(用户选择,默认当前登录人)
- 请假类型(单选:事假/病假/年假/调休)
- 开始日期、结束日期
- 请假天数(整数)
- 请假原因(多行文本,必填)
- 附件
```
### 采购申请(带子表)
```
创建采购申请单:
主表字段:采购标题(必填)、采购部门、采购日期、总金额、备注
子表明细:物品名称、规格型号、数量(整数)、单价(金额)、小计(金额)
```
### 客户信息管理
```
创建客户信息表单:
- 客户名称(必填)、联系人、手机、邮箱 — 前两个一行两字段
- 所在地区(省市级联动)
- 客户类型(下拉:潜在客户/意向客户/成交客户)
- 客户等级评分5星
- 备注(富文本编辑器)
```
---
## 注意事项
1. **Token 有效期**X-Access-Token 有过期时间,过期后需重新获取
2. **表单编码唯一**:同一系统中 desformCode 不能重复
3. **设计器表单 vs Online 表单**:本 skill 只处理设计器表单desform不涉及 Online 表单
4. **创建后可在设计器中微调**AI 创建的表单可以在设计器界面中继续编辑完善