diff --git a/docs/02-功能清单/管理后台/09-系统设置/09-01-系统设置页面.md b/docs/02-功能清单/管理后台/09-系统设置/09-01-系统设置页面.md index 250a1cd..0066534 100644 --- a/docs/02-功能清单/管理后台/09-系统设置/09-01-系统设置页面.md +++ b/docs/02-功能清单/管理后台/09-系统设置/09-01-系统设置页面.md @@ -171,10 +171,34 @@ 系统配置列表无数据:el-empty 暂无配置项 车间列表无数据:el-empty 暂无车间数据,点击新增车间添加 -### 9. Mock数据 +### 9. 接口引用与数据结构 -**GET /api/admin/sys-config 系统配置列表:** +> 端点编号对应 `03-API接口设计.md` §3.9 系统设置模块端点清单。 +#### 接口引用表 + +| 操作 | 端点编号 | Method | Mock调用 | 正式API调用 | 说明 | +|------|---------|--------|---------|------------|------| +| 配置项列表 | §3.9 #1 | GET | GET /mock-api/admin/sys-config | GET /api/admin/sys-config | 读取配置列表 | +| 编辑配置项 | §3.9 #2 | PUT | POST /mock-api/admin/sys-config/update | PUT /api/admin/sys-config/{id} | Mock放body,正式API用路径参数 | +| 重置Token | §3.9 #3 | POST | POST /mock-api/admin/sys-config/reset-token | POST /api/admin/sys-config/reset-token | 两种风格URL一致 | +| 车间列表 | §3.9 #4 | GET | GET /mock-api/admin/workshop | GET /api/admin/workshop | 读取车间列表 | +| 新增车间 | §3.9 #5 | POST | POST /mock-api/admin/workshop | POST /api/admin/workshop | 两种风格URL一致 | +| 编辑车间 | §3.9 #6 | PUT | POST /mock-api/admin/workshop/update | PUT /api/admin/workshop/{id} | Mock放body,正式API用路径参数 | +| 删除车间 | §3.9 #7 | DELETE | POST /mock-api/admin/workshop/delete | DELETE /api/admin/workshop/{id} | Mock放body,正式API用路径参数 | +| 启停车间 | §3.9 #8 | PUT | POST /mock-api/admin/workshop/toggle | PUT /api/admin/workshop/{id}/toggle | Mock放body,正式API用路径参数 | +| 修改密码 | §3.9 #9 | POST | POST /mock-api/admin/change-password | POST /api/admin/change-password | 两种风格URL一致 | + +#### 数据结构 + +**配置项列表(端点 §3.9 #1):** + +``` +GET /mock-api/admin/sys-config → Mock调用 +GET /api/admin/sys-config → 正式API调用 +``` + +Response: ```json { "code": 0, "data": { "items": [ { "id": 1, "configKey": "ping_interval", "configValue": "60", "valueType": "number", "description": "Ping检测间隔(秒)" }, @@ -190,20 +214,38 @@ ]}} ``` -**PUT /api/admin/sys-config/1 编辑配置项:** +**编辑配置项(端点 §3.9 #2):** + +``` +Mock调用: POST /mock-api/admin/sys-config/update body: { "id": 1, "configValue": "120" } +正式API调用: PUT /api/admin/sys-config/1 body: { "configValue": "120" } +``` +Response: ```json { "code": 0, "message": "success", "data": null } ``` -**POST /api/admin/sys-config/reset-token 重置Token:** +**重置Token(端点 §3.9 #3):** +``` +Mock调用: POST /mock-api/admin/sys-config/reset-token body: { "id": 8 } +正式API调用: POST /api/admin/sys-config/reset-token body: { "id": 8 } +``` + +Response: ```json -{ "code": 0, "data": { "configKey": "api_token", "newValue": "eyJhbGciOiJIUzI1NiJ9.new.random.token" }} +{ "code": 0, "data": { "configKey": "api_token", "newValue": "eyJhbGciOiJIUzI1NiJ9.new.token" }} ``` -**GET /api/admin/workshop 车间列表:** +**车间列表(端点 §3.9 #4):** + +``` +Mock调用: GET /mock-api/admin/workshop +正式API调用: GET /api/admin/workshop +``` +Response: ```json { "code": 0, "data": { "items": [ { "id": 1, "name": "A栋", "sortOrder": 1, "isEnabled": 1, "machineCount": 32 }, @@ -212,20 +254,67 @@ ]}} ``` -**POST /api/admin/workshop 新增车间:** +**新增车间(端点 §3.9 #5):** +``` +Mock调用: POST /mock-api/admin/workshop body: { "name": "D栋", "sortOrder": 4 } +正式API调用: POST /api/admin/workshop body: { "name": "D栋", "sortOrder": 4 } +``` + +Response: ```json { "code": 0, "message": "success", "data": { "id": 4, "name": "D栋" }} ``` -**POST /api/admin/change-password 修改密码:** +**编辑车间(端点 §3.9 #6):** +``` +Mock调用: POST /mock-api/admin/workshop/update body: { "id": 1, "name": "A栋-新", "sortOrder": 1 } +正式API调用: PUT /api/admin/workshop/1 body: { "name": "A栋-新", "sortOrder": 1 } +``` + +Response: ```json { "code": 0, "message": "success", "data": null } ``` -**POST /api/admin/change-password 修改密码失败(旧密码错误):** +**删除车间(端点 §3.9 #7):** + +``` +Mock调用: POST /mock-api/admin/workshop/delete body: { "id": 3 } +正式API调用: DELETE /api/admin/workshop/3 +``` + +Response: +```json +{ "code": 0, "message": "success", "data": null } +``` + +**启停车间(端点 §3.9 #8):** + +``` +Mock调用: POST /mock-api/admin/workshop/toggle body: { "id": 3 } +正式API调用: PUT /api/admin/workshop/3/toggle +``` + +Response: +```json +{ "code": 0, "message": "success", "data": null } +``` + +**修改密码(端点 §3.9 #9):** + +``` +Mock调用: POST /mock-api/admin/change-password body: { "currentPassword": "admin123", "newPassword": "newpass123" } +正式API调用: POST /api/admin/change-password body: { "currentPassword": "admin123", "newPassword": "newpass123" } +``` + +成功 Response: +```json +{ "code": 0, "message": "success", "data": null } +``` +失败 Response(旧密码错误): ```json { "code": 40001, "message": "当前密码不正确", "data": null } ```