规范:精简系统设置页面§9,引用表只列编号+界面用途,不重复URL;数据结构保留完整JSON

main
haoliang 1 week ago
parent 16fac603fc
commit 293e1cf233

@ -173,30 +173,25 @@
### 9. 接口引用与数据结构
> 端点编号对应 `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一致 |
> Mock/正式API的URL、HTTP方法均定义在 `03-API接口设计.md` §3.9 端点清单,本节仅引用编号并定义返回数据结构
#### 接口引用
| 接口名称 | 端点编号 | 界面用途 |
|---------|---------|---------|
| 配置项列表 | §3.9 #1 | Tab1系统配置列表渲染表格 |
| 编辑配置项 | §3.9 #2 | Tab1编辑弹窗保存 |
| 重置Token | §3.9 #3 | Tab1重置Token操作 |
| 车间列表 | §3.9 #4 | Tab2车间管理列表渲染表格 |
| 新增车间 | §3.9 #5 | Tab2新增弹窗保存 |
| 编辑车间 | §3.9 #6 | Tab2编辑弹窗保存 |
| 删除车间 | §3.9 #7 | Tab2删除操作 |
| 启停车间 | §3.9 #8 | Tab2启停切换 |
| 修改密码 | §3.9 #9 | Tab3修改密码表单提交 |
#### 数据结构
**配置项列表(端点 §3.9 #1**
```
GET /mock-api/admin/sys-config → Mock调用
GET /api/admin/sys-config → 正式API调用
```
**配置项列表§3.9 #1**
Response
```json
@ -214,11 +209,11 @@ Response
]}}
```
**编辑配置项(端点 §3.9 #2**
**编辑配置项§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" }
Request body
```json
{ "id": 1, "configValue": "120" }
```
Response
@ -226,11 +221,11 @@ Response
{ "code": 0, "message": "success", "data": null }
```
**重置Token端点 §3.9 #3**
**重置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 }
Request body
```json
{ "id": 8 }
```
Response
@ -238,12 +233,7 @@ Response
{ "code": 0, "data": { "configKey": "api_token", "newValue": "eyJhbGciOiJIUzI1NiJ9.new.token" }}
```
**车间列表(端点 §3.9 #4**
```
Mock调用 GET /mock-api/admin/workshop
正式API调用 GET /api/admin/workshop
```
**车间列表§3.9 #4**
Response
```json
@ -254,11 +244,11 @@ Response
]}}
```
**新增车间(端点 §3.9 #5**
**新增车间§3.9 #5**
```
Mock调用 POST /mock-api/admin/workshop body: { "name": "D栋", "sortOrder": 4 }
正式API调用 POST /api/admin/workshop body: { "name": "D栋", "sortOrder": 4 }
Request body
```json
{ "name": "D栋", "sortOrder": 4 }
```
Response
@ -266,11 +256,11 @@ Response
{ "code": 0, "message": "success", "data": { "id": 4, "name": "D栋" }}
```
**编辑车间(端点 §3.9 #6**
**编辑车间§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 }
Request body
```json
{ "id": 1, "name": "A栋-新", "sortOrder": 1 }
```
Response
@ -278,11 +268,11 @@ Response
{ "code": 0, "message": "success", "data": null }
```
**删除车间(端点 §3.9 #7**
**删除车间§3.9 #7**
```
Mock调用 POST /mock-api/admin/workshop/delete body: { "id": 3 }
正式API调用 DELETE /api/admin/workshop/3
Request body
```json
{ "id": 3 }
```
Response
@ -290,11 +280,11 @@ Response
{ "code": 0, "message": "success", "data": null }
```
**启停车间(端点 §3.9 #8**
**启停车间§3.9 #8**
```
Mock调用 POST /mock-api/admin/workshop/toggle body: { "id": 3 }
正式API调用 PUT /api/admin/workshop/3/toggle
Request body
```json
{ "id": 3 }
```
Response
@ -302,11 +292,11 @@ Response
{ "code": 0, "message": "success", "data": null }
```
**修改密码(端点 §3.9 #9**
**修改密码§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" }
Request body
```json
{ "currentPassword": "admin123", "newPassword": "newpass123" }
```
成功 Response

Loading…
Cancel
Save