组件新增状态字段,禁用状态不参与拼装
This commit is contained in:
@@ -144,6 +144,7 @@ POST 和 PUT 使用扁平 JSON。新增业务字段仅 `stepObjectKey` 必填,
|
||||
| --- | --- | --- |
|
||||
| componentName | string | POST 可选,默认 `""`;PUT 必填、非空;最多 128 字符,允许同名 |
|
||||
| category | string | POST 可选,默认 `""`;PUT 必填、非空;最多 64 字符,自由分类 |
|
||||
| status | string / null | 仅接受 `ENABLED`(启用)、`DISABLED`(禁用);POST 省略或为 null 时默认启用,PUT 省略或为 null 时保留原状态 |
|
||||
| description | string | 默认 `""`,UTF-8 不超过 65535 字节 |
|
||||
| material | string | 默认 `""`,最多 128 字符 |
|
||||
| massKg | number | 默认 0,千克,非负 |
|
||||
@@ -158,7 +159,7 @@ POST 和 PUT 使用扁平 JSON。新增业务字段仅 `stepObjectKey` 必填,
|
||||
| basicFields | 自定义字段数组 | 默认 `[]`,基本信息扩展字段 |
|
||||
| parameterFields | 自定义字段数组 | 默认 `[]`,零件参数扩展字段 |
|
||||
|
||||
质量和扭矩最多 12 位整数、6 位小数,与 `DECIMAL(18,6)` 一致;不要在数值中提交单位文本。可选字段省略或传 null 会恢复默认值。名称、分类、材质、功能、形状和大小会裁剪首尾空白。
|
||||
质量和扭矩最多 12 位整数、6 位小数,与 `DECIMAL(18,6)` 一致;不要在数值中提交单位文本。除 PUT 的 `status` 保留原值外,可选字段省略或传 null 会恢复默认值。名称、分类、材质、功能、形状和大小会裁剪首尾空白。
|
||||
|
||||
`bomList` 和 `urdfInfo` 直接提交 JSON 对象或数组,不接受字符串化的 JSON、数字或布尔值。`bomList` 省略或为 null 时保存为空数组;新增时 `urdfInfo` 省略或为 null 也保存为空数组,修改时仍须提供 JSON 对象或数组。两者内部字段不做固定结构校验,`urdfInfo` 由前端提供,不由后端解析 URDF 文件生成。
|
||||
|
||||
@@ -173,7 +174,9 @@ POST 和 PUT 使用扁平 JSON。新增业务字段仅 `stepObjectKey` 必填,
|
||||
|
||||
每组最多 100 项,名称非空且最多 64 字符,值为非 null 字符串、最多 2000 字符,可以为空字符串。同组名称裁剪后不可重复,两组之间可以重名;顺序与请求一致。
|
||||
|
||||
PUT 是全量表单更新,前端应提交完整表单,每次都必须提交 `urdfInfo`。省略可选字段会恢复默认值,提交空数组可清空 BOM 或自定义字段。
|
||||
PUT 是全量表单更新,前端应提交完整表单,每次都必须提交 `urdfInfo`。除 `status` 外,省略可选字段会恢复默认值,提交空数组可清空 BOM 或自定义字段。
|
||||
|
||||
`status` 对应数据库 `status`,新增和存量组件默认 `ENABLED`。通过现有 PUT 编辑接口切换状态,仍须提交完整必填表单和最新 `version`,保存成功后版本递增。非法状态(包括小写、空字符串和数字)返回 422。禁用组件仍可在管理端列表、详情中查看和编辑,也可重新启用;禁用后不参与新生成的结构化匹配、AI 拼装或替代候选。用户端按编码查询详情、历史生成结果和已保存项目继续可查看。
|
||||
|
||||
`rotationAxis` 对应数据库 `rotation_axis`,下拉选项值使用 `X`、`Y`、`Z`;未设置时返回 null。PUT 省略该字段或传 null 会清空已有旋转轴。该字段是组件元数据,不替代 `urdfInfo` 中每个关节的 axis。
|
||||
|
||||
@@ -202,6 +205,19 @@ ALTER TABLE `component`
|
||||
AFTER `degrees_of_freedom`;
|
||||
```
|
||||
|
||||
### 4.4 组件状态字段部署
|
||||
|
||||
部署管理端和用户端新代码前,在两端使用的组件数据库中手动执行以下 SQL。已有记录自动获得启用状态,应用不会自动执行迁移;仓库 `.sql` 文件不修改。
|
||||
|
||||
```sql
|
||||
ALTER TABLE `component`
|
||||
ADD COLUMN `status` ENUM('ENABLED', 'DISABLED')
|
||||
CHARACTER SET ascii COLLATE ascii_bin
|
||||
NOT NULL DEFAULT 'ENABLED'
|
||||
COMMENT '组件状态:ENABLED-启用,DISABLED-禁用'
|
||||
AFTER `category`;
|
||||
```
|
||||
|
||||
## 5. 组件接口
|
||||
|
||||
### 5.1 新增
|
||||
@@ -215,12 +231,13 @@ ALTER TABLE `component`
|
||||
}
|
||||
```
|
||||
|
||||
其余业务字段按默认值保存;`bomList`、`urdfInfo` 虽为 NOT NULL,后端会显式写入空数组。部署前须完成上面的旋转轴字段迁移。需要填写元数据或上传 URDF 时,可提交完整请求:
|
||||
其余业务字段按默认值保存;`bomList`、`urdfInfo` 虽为 NOT NULL,后端会显式写入空数组。部署前须完成上面的旋转轴和组件状态字段迁移。需要填写元数据或上传 URDF 时,可提交完整请求:
|
||||
|
||||
```json
|
||||
{
|
||||
"componentName":"四孔安装板",
|
||||
"category":"安装板",
|
||||
"status":"ENABLED",
|
||||
"description":"用于固定机械组件",
|
||||
"material":"铝合金",
|
||||
"massKg":0.35,
|
||||
@@ -255,6 +272,7 @@ ALTER TABLE `component`
|
||||
"componentCode":"CW-7K3M9Q2R6V8X4T5N",
|
||||
"componentName":"四孔安装板",
|
||||
"category":"安装板",
|
||||
"status":"ENABLED",
|
||||
"description":"用于固定机械组件",
|
||||
"material":"铝合金",
|
||||
"massKg":0.35,
|
||||
@@ -292,6 +310,7 @@ ALTER TABLE `component`
|
||||
"version":1,
|
||||
"componentName":"四孔安装板 V2",
|
||||
"category":"安装板",
|
||||
"status":"ENABLED",
|
||||
"description":"更新说明",
|
||||
"material":"铝合金",
|
||||
"massKg":0.35,
|
||||
@@ -331,7 +350,7 @@ ALTER TABLE `component`
|
||||
| keyword | 名称或编码模糊查询 |
|
||||
| category | 分类精确筛选 |
|
||||
|
||||
`items` 每项包含 `id`、`componentCode`、`componentName`、`category`、`description`、`degreesOfFreedom`、`rotationAxis`、`functionDescription`、`shape`、`size`、`torqueNm`、`stepUrl`、`urdfUrl`、`version`、`createdAt`、`updatedAt`。列表不查询或返回 `bomList`、`urdfInfo`、自定义表单和 URDF 文件清单。编辑先获取详情;创建和修改成功返回完整组件详情,包含旋转轴。
|
||||
`items` 每项包含 `id`、`componentCode`、`componentName`、`category`、`status`、`description`、`degreesOfFreedom`、`rotationAxis`、`functionDescription`、`shape`、`size`、`torqueNm`、`stepUrl`、`urdfUrl`、`version`、`createdAt`、`updatedAt`。列表不查询或返回 `bomList`、`urdfInfo`、自定义表单和 URDF 文件清单。编辑先获取详情;创建和修改成功返回完整组件详情,包含状态和旋转轴。
|
||||
|
||||
列表查询参数 `size` 是每页条数,响应 `items` 内的 `size` 是组件大小描述。
|
||||
|
||||
|
||||
Reference in New Issue
Block a user